chillerlan-QRCode-Data-QRMatrix.html 170 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  105. </ul>
  106. <article class="phpdocumentor-element -class">
  107. <h2 class="phpdocumentor-content__title">
  108. QRMatrix
  109. <div class="phpdocumentor-element__package">
  110. in package
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  113. </ul>
  114. </div>
  115. </h2>
  116. <div class="phpdocumentor-label-line">
  117. </div>
  118. <aside class="phpdocumentor-element-found-in">
  119. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  120. :
  121. <span class="phpdocumentor-element-found-in__line">22</span>
  122. </aside>
  123. <p class="phpdocumentor-summary">Holds an array representation of the final QR Code that contains numerical values for later output modifications;
  124. maps the ECC coded binary data and applies the mask pattern</p>
  125. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  126. Tags
  127. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  128. </h5>
  129. <dl class="phpdocumentor-tag-list">
  130. <dt class="phpdocumentor-tag-list__entry">
  131. <span class="phpdocumentor-tag__name">see</span>
  132. </dt>
  133. <dd class="phpdocumentor-tag-list__definition">
  134. <span class="phpdocumentor-tag-link"><a href="http://www.thonky.com/qr-code-tutorial/format-version-information">http://www.thonky.com/qr-code-tutorial/format-version-information</a></span>
  135. </dd>
  136. </dl>
  137. <h3 id="toc">
  138. Table of Contents
  139. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  140. </h3>
  141. <h4 id="toc-constants">
  142. Constants
  143. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  144. </h4>
  145. <dl class="phpdocumentor-table-of-contents">
  146. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  147. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK">IS_DARK</a>
  148. <span>
  149. &nbsp;= 0b100000000000 </span>
  150. </dt>
  151. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  152. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT">M_ALIGNMENT</a>
  153. <span>
  154. &nbsp;= 0b10000 </span>
  155. </dt>
  156. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  157. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK">M_ALIGNMENT_DARK</a>
  158. <span>
  159. &nbsp;= 0b100000010000 </span>
  160. </dt>
  161. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  162. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE">M_DARKMODULE</a>
  163. <span>
  164. &nbsp;= 0b100000000001 </span>
  165. </dt>
  166. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  167. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE_LIGHT">M_DARKMODULE_LIGHT</a>
  168. <span>
  169. &nbsp;= 0b1 </span>
  170. </dt>
  171. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  172. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA">M_DATA</a>
  173. <span>
  174. &nbsp;= 0b10 </span>
  175. </dt>
  176. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  177. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK">M_DATA_DARK</a>
  178. <span>
  179. &nbsp;= 0b100000000010 </span>
  180. </dt>
  181. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  182. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER">M_FINDER</a>
  183. <span>
  184. &nbsp;= 0b100 </span>
  185. </dt>
  186. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  187. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK">M_FINDER_DARK</a>
  188. <span>
  189. &nbsp;= 0b100000000100 </span>
  190. </dt>
  191. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  192. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT">M_FINDER_DOT</a>
  193. <span>
  194. &nbsp;= 0b110000000000 </span>
  195. </dt>
  196. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  197. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT_LIGHT">M_FINDER_DOT_LIGHT</a>
  198. <span>
  199. &nbsp;= 0b10000000000 </span>
  200. </dt>
  201. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  202. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT">M_FORMAT</a>
  203. <span>
  204. &nbsp;= 0b1000000 </span>
  205. </dt>
  206. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  207. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK">M_FORMAT_DARK</a>
  208. <span>
  209. &nbsp;= 0b100001000000 </span>
  210. </dt>
  211. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  212. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO">M_LOGO</a>
  213. <span>
  214. &nbsp;= 0b1000000000 </span>
  215. </dt>
  216. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  217. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO_DARK">M_LOGO_DARK</a>
  218. <span>
  219. &nbsp;= 0b101000000000 </span>
  220. </dt>
  221. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  222. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL">M_NULL</a>
  223. <span>
  224. &nbsp;= 0b0 </span>
  225. </dt>
  226. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  227. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE">M_QUIETZONE</a>
  228. <span>
  229. &nbsp;= 0b100000000 </span>
  230. </dt>
  231. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  232. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE_DARK">M_QUIETZONE_DARK</a>
  233. <span>
  234. &nbsp;= 0b100100000000 </span>
  235. </dt>
  236. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  237. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR">M_SEPARATOR</a>
  238. <span>
  239. &nbsp;= 0b1000 </span>
  240. </dt>
  241. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  242. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR_DARK">M_SEPARATOR_DARK</a>
  243. <span>
  244. &nbsp;= 0b100000001000 </span>
  245. </dt>
  246. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  247. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING">M_TIMING</a>
  248. <span>
  249. &nbsp;= 0b100000 </span>
  250. </dt>
  251. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  252. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK">M_TIMING_DARK</a>
  253. <span>
  254. &nbsp;= 0b100000100000 </span>
  255. </dt>
  256. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  257. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION">M_VERSION</a>
  258. <span>
  259. &nbsp;= 0b10000000 </span>
  260. </dt>
  261. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  262. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK">M_VERSION_DARK</a>
  263. <span>
  264. &nbsp;= 0b100010000000 </span>
  265. </dt>
  266. <dt class="phpdocumentor-table-of-contents__entry -constant -protected">
  267. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours">neighbours</a>
  268. <span>
  269. &nbsp;= [0b1 =&gt; [-1, -1], 0b10 =&gt; [0, -1], 0b100 =&gt; [1, -1], 0b1000 =&gt; [1, 0], 0b10000 =&gt; [1, 1], 0b100000 =&gt; [0, 1], 0b1000000 =&gt; [-1, 1], 0b10000000 =&gt; [-1, 0]] </span>
  270. </dt>
  271. <dd>Map of flag =&gt; coord</dd>
  272. </dl>
  273. <h4 id="toc-properties">
  274. Properties
  275. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  276. </h4>
  277. <dl class="phpdocumentor-table-of-contents">
  278. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  279. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel">$eccLevel</a>
  280. <span>
  281. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  282. </dt>
  283. <dd>the current ECC level - always set in QRMatrix, may be null in BitMatrix</dd>
  284. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  285. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern">$maskPattern</a>
  286. <span>
  287. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  288. </dt>
  289. <dd>the mask pattern that was used in the most recent operation, set via:</dd>
  290. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  291. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix">$matrix</a>
  292. <span>
  293. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt; </span>
  294. </dt>
  295. <dd>the actual matrix data array</dd>
  296. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  297. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount">$moduleCount</a>
  298. <span>
  299. &nbsp;: int </span>
  300. </dt>
  301. <dd>the size (side length) of the matrix, including quiet zone (if created)</dd>
  302. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  303. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version">$version</a>
  304. <span>
  305. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  306. </dt>
  307. <dd>the matrix version - always set in QRMatrix, may be null in BitMatrix</dd>
  308. </dl>
  309. <h4 id="toc-methods">
  310. Methods
  311. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  312. </h4>
  313. <dl class="phpdocumentor-table-of-contents">
  314. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  315. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct">__construct()</a>
  316. <span>
  317. &nbsp;: mixed </span>
  318. </dt>
  319. <dd>QRMatrix constructor.</dd>
  320. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  321. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check">check()</a>
  322. <span>
  323. &nbsp;: bool </span>
  324. </dt>
  325. <dd>Checks whether the module at ($x, $y) is true (dark) or false (light)</dd>
  326. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  327. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours">checkNeighbours()</a>
  328. <span>
  329. &nbsp;: int </span>
  330. </dt>
  331. <dd>Checks the status of the neighbouring modules for the module at ($x, $y) and returns a bitmask with the results.</dd>
  332. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  333. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType">checkType()</a>
  334. <span>
  335. &nbsp;: bool </span>
  336. </dt>
  337. <dd>Checks whether the module at ($x, $y) is of the given $M_TYPE</dd>
  338. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  339. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn">checkTypeIn()</a>
  340. <span>
  341. &nbsp;: bool </span>
  342. </dt>
  343. <dd>Checks whether the module at ($x, $y) is in the given array of $M_TYPES,
  344. returns true if a match is found, otherwise false.</dd>
  345. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  346. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel">eccLevel()</a>
  347. <span>
  348. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  349. </dt>
  350. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  351. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip">flip()</a>
  352. <span>
  353. &nbsp;: self </span>
  354. </dt>
  355. <dd>Flips the value of the module at ($x, $y)</dd>
  356. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  357. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get">get()</a>
  358. <span>
  359. &nbsp;: int </span>
  360. </dt>
  361. <dd>Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix</dd>
  362. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  363. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel">getEccLevel()</a>
  364. <span>
  365. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  366. </dt>
  367. <dd>Returns the current ECC level</dd>
  368. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  369. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern">getMaskPattern()</a>
  370. <span>
  371. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  372. </dt>
  373. <dd>Returns the current mask pattern</dd>
  374. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  375. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix">getMatrix()</a>
  376. <span>
  377. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt; </span>
  378. </dt>
  379. <dd>Returns the data matrix, returns a pure boolean representation if $boolean is set to true</dd>
  380. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  381. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize">getSize()</a>
  382. <span>
  383. &nbsp;: int </span>
  384. </dt>
  385. <dd>Returns the absoulute size of the matrix, including quiet zone (after setting it).</dd>
  386. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  387. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion">getVersion()</a>
  388. <span>
  389. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  390. </dt>
  391. <dd>Returns the current version number</dd>
  392. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  393. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns">initFunctionalPatterns()</a>
  394. <span>
  395. &nbsp;: self </span>
  396. </dt>
  397. <dd>shortcut to initialize the functional patterns</dd>
  398. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  399. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_invert">invert()</a>
  400. <span>
  401. &nbsp;: self </span>
  402. </dt>
  403. <dd>Inverts the values of the whole matrix</dd>
  404. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  405. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask">mask()</a>
  406. <span>
  407. &nbsp;: self </span>
  408. </dt>
  409. <dd>Applies/reverses the mask pattern</dd>
  410. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  411. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern">maskPattern()</a>
  412. <span>
  413. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  414. </dt>
  415. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  416. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix">matrix()</a>
  417. <span>
  418. &nbsp;: array&lt;string|int, mixed&gt; </span>
  419. </dt>
  420. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  421. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_rotate90">rotate90()</a>
  422. <span>
  423. &nbsp;: self </span>
  424. </dt>
  425. <dd>Rotates the matrix by 90 degrees clock wise</dd>
  426. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  427. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set">set()</a>
  428. <span>
  429. &nbsp;: self </span>
  430. </dt>
  431. <dd>Sets the $M_TYPE value for the module at position [$x, $y]</dd>
  432. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  433. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern">setAlignmentPattern()</a>
  434. <span>
  435. &nbsp;: self </span>
  436. </dt>
  437. <dd>Draws the 5x5 alignment patterns</dd>
  438. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  439. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setArea">setArea()</a>
  440. <span>
  441. &nbsp;: self </span>
  442. </dt>
  443. <dd>Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.</dd>
  444. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  445. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule">setDarkModule()</a>
  446. <span>
  447. &nbsp;: self </span>
  448. </dt>
  449. <dd>Sets the &quot;dark module&quot;, that is always on the same position 1x1px away from the bottom left finder</dd>
  450. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  451. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern">setFinderPattern()</a>
  452. <span>
  453. &nbsp;: self </span>
  454. </dt>
  455. <dd>Draws the 7x7 finder patterns in the corners top left/right and bottom left</dd>
  456. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  457. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo">setFormatInfo()</a>
  458. <span>
  459. &nbsp;: self </span>
  460. </dt>
  461. <dd>Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false.</dd>
  462. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  463. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace">setLogoSpace()</a>
  464. <span>
  465. &nbsp;: self </span>
  466. </dt>
  467. <dd>Clears a space of $width * $height in order to add a logo or text.</dd>
  468. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  469. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone">setQuietZone()</a>
  470. <span>
  471. &nbsp;: self </span>
  472. </dt>
  473. <dd>Draws the &quot;quiet zone&quot; of $size around the matrix</dd>
  474. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  475. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators">setSeparators()</a>
  476. <span>
  477. &nbsp;: self </span>
  478. </dt>
  479. <dd>Draws the separator lines around the finder patterns</dd>
  480. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  481. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern">setTimingPattern()</a>
  482. <span>
  483. &nbsp;: self </span>
  484. </dt>
  485. <dd>Draws the timing pattern (h/v checkered line between the finder patterns)</dd>
  486. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  487. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber">setVersionNumber()</a>
  488. <span>
  489. &nbsp;: self </span>
  490. </dt>
  491. <dd>Draws the version information, 2x 3x6 pixel</dd>
  492. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  493. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size">size()</a>
  494. <span>
  495. &nbsp;: int </span>
  496. </dt>
  497. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  498. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version">version()</a>
  499. <span>
  500. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  501. </dt>
  502. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  503. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords">writeCodewords()</a>
  504. <span>
  505. &nbsp;: self </span>
  506. </dt>
  507. <dd>Maps the interleaved binary $data on the matrix</dd>
  508. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  509. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix">createMatrix()</a>
  510. <span>
  511. &nbsp;: array&lt;string|int, mixed&gt; </span>
  512. </dt>
  513. <dd>Creates a 2-dimensional array (square) of the given $size</dd>
  514. </dl>
  515. <section class="phpdocumentor-constants">
  516. <h3 class="phpdocumentor-elements__header" id="constants">
  517. Constants
  518. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  519. </h3>
  520. <article class="phpdocumentor-element -constant -public ">
  521. <h4 class="phpdocumentor-element__name" id="constant_IS_DARK">
  522. IS_DARK
  523. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  524. </h4>
  525. <aside class="phpdocumentor-element-found-in">
  526. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  527. :
  528. <span class="phpdocumentor-element-found-in__line">29</span>
  529. </aside>
  530. <code class="phpdocumentor-signature phpdocumentor-code ">
  531. <span class="phpdocumentor-signature__visibility">public</span>
  532. <span class="phpdocumentor-signature__type">int</span>
  533. <span class="phpdocumentor-signature__name">IS_DARK</span>
  534. = <span class="phpdocumentor-signature__default-value">0b100000000000</span>
  535. </code>
  536. </article>
  537. <article class="phpdocumentor-element -constant -public ">
  538. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT">
  539. M_ALIGNMENT
  540. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT" class="headerlink"><i class="fas fa-link"></i></a>
  541. </h4>
  542. <aside class="phpdocumentor-element-found-in">
  543. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  544. :
  545. <span class="phpdocumentor-element-found-in__line">48</span>
  546. </aside>
  547. <code class="phpdocumentor-signature phpdocumentor-code ">
  548. <span class="phpdocumentor-signature__visibility">public</span>
  549. <span class="phpdocumentor-signature__type">int</span>
  550. <span class="phpdocumentor-signature__name">M_ALIGNMENT</span>
  551. = <span class="phpdocumentor-signature__default-value">0b10000</span>
  552. </code>
  553. </article>
  554. <article class="phpdocumentor-element -constant -public ">
  555. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT_DARK">
  556. M_ALIGNMENT_DARK
  557. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  558. </h4>
  559. <aside class="phpdocumentor-element-found-in">
  560. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  561. :
  562. <span class="phpdocumentor-element-found-in__line">69</span>
  563. </aside>
  564. <code class="phpdocumentor-signature phpdocumentor-code ">
  565. <span class="phpdocumentor-signature__visibility">public</span>
  566. <span class="phpdocumentor-signature__type">int</span>
  567. <span class="phpdocumentor-signature__name">M_ALIGNMENT_DARK</span>
  568. = <span class="phpdocumentor-signature__default-value">0b100000010000</span>
  569. </code>
  570. </article>
  571. <article class="phpdocumentor-element -constant -public ">
  572. <h4 class="phpdocumentor-element__name" id="constant_M_DARKMODULE">
  573. M_DARKMODULE
  574. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE" class="headerlink"><i class="fas fa-link"></i></a>
  575. </h4>
  576. <aside class="phpdocumentor-element-found-in">
  577. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  578. :
  579. <span class="phpdocumentor-element-found-in__line">63</span>
  580. </aside>
  581. <code class="phpdocumentor-signature phpdocumentor-code ">
  582. <span class="phpdocumentor-signature__visibility">public</span>
  583. <span class="phpdocumentor-signature__type">int</span>
  584. <span class="phpdocumentor-signature__name">M_DARKMODULE</span>
  585. = <span class="phpdocumentor-signature__default-value">0b100000000001</span>
  586. </code>
  587. </article>
  588. <article class="phpdocumentor-element -constant -public ">
  589. <h4 class="phpdocumentor-element__name" id="constant_M_DARKMODULE_LIGHT">
  590. M_DARKMODULE_LIGHT
  591. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE_LIGHT" class="headerlink"><i class="fas fa-link"></i></a>
  592. </h4>
  593. <aside class="phpdocumentor-element-found-in">
  594. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  595. :
  596. <span class="phpdocumentor-element-found-in__line">84</span>
  597. </aside>
  598. <code class="phpdocumentor-signature phpdocumentor-code ">
  599. <span class="phpdocumentor-signature__visibility">public</span>
  600. <span class="phpdocumentor-signature__type">int</span>
  601. <span class="phpdocumentor-signature__name">M_DARKMODULE_LIGHT</span>
  602. = <span class="phpdocumentor-signature__default-value">0b1</span>
  603. </code>
  604. </article>
  605. <article class="phpdocumentor-element -constant -public ">
  606. <h4 class="phpdocumentor-element__name" id="constant_M_DATA">
  607. M_DATA
  608. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA" class="headerlink"><i class="fas fa-link"></i></a>
  609. </h4>
  610. <aside class="phpdocumentor-element-found-in">
  611. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  612. :
  613. <span class="phpdocumentor-element-found-in__line">42</span>
  614. </aside>
  615. <code class="phpdocumentor-signature phpdocumentor-code ">
  616. <span class="phpdocumentor-signature__visibility">public</span>
  617. <span class="phpdocumentor-signature__type">int</span>
  618. <span class="phpdocumentor-signature__name">M_DATA</span>
  619. = <span class="phpdocumentor-signature__default-value">0b10</span>
  620. </code>
  621. </article>
  622. <article class="phpdocumentor-element -constant -public ">
  623. <h4 class="phpdocumentor-element__name" id="constant_M_DATA_DARK">
  624. M_DATA_DARK
  625. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  626. </h4>
  627. <aside class="phpdocumentor-element-found-in">
  628. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  629. :
  630. <span class="phpdocumentor-element-found-in__line">65</span>
  631. </aside>
  632. <code class="phpdocumentor-signature phpdocumentor-code ">
  633. <span class="phpdocumentor-signature__visibility">public</span>
  634. <span class="phpdocumentor-signature__type">int</span>
  635. <span class="phpdocumentor-signature__name">M_DATA_DARK</span>
  636. = <span class="phpdocumentor-signature__default-value">0b100000000010</span>
  637. </code>
  638. </article>
  639. <article class="phpdocumentor-element -constant -public ">
  640. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER">
  641. M_FINDER
  642. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER" class="headerlink"><i class="fas fa-link"></i></a>
  643. </h4>
  644. <aside class="phpdocumentor-element-found-in">
  645. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  646. :
  647. <span class="phpdocumentor-element-found-in__line">44</span>
  648. </aside>
  649. <code class="phpdocumentor-signature phpdocumentor-code ">
  650. <span class="phpdocumentor-signature__visibility">public</span>
  651. <span class="phpdocumentor-signature__type">int</span>
  652. <span class="phpdocumentor-signature__name">M_FINDER</span>
  653. = <span class="phpdocumentor-signature__default-value">0b100</span>
  654. </code>
  655. </article>
  656. <article class="phpdocumentor-element -constant -public ">
  657. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DARK">
  658. M_FINDER_DARK
  659. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  660. </h4>
  661. <aside class="phpdocumentor-element-found-in">
  662. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  663. :
  664. <span class="phpdocumentor-element-found-in__line">67</span>
  665. </aside>
  666. <code class="phpdocumentor-signature phpdocumentor-code ">
  667. <span class="phpdocumentor-signature__visibility">public</span>
  668. <span class="phpdocumentor-signature__type">int</span>
  669. <span class="phpdocumentor-signature__name">M_FINDER_DARK</span>
  670. = <span class="phpdocumentor-signature__default-value">0b100000000100</span>
  671. </code>
  672. </article>
  673. <article class="phpdocumentor-element -constant -public ">
  674. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DOT">
  675. M_FINDER_DOT
  676. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT" class="headerlink"><i class="fas fa-link"></i></a>
  677. </h4>
  678. <aside class="phpdocumentor-element-found-in">
  679. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  680. :
  681. <span class="phpdocumentor-element-found-in__line">77</span>
  682. </aside>
  683. <code class="phpdocumentor-signature phpdocumentor-code ">
  684. <span class="phpdocumentor-signature__visibility">public</span>
  685. <span class="phpdocumentor-signature__type">int</span>
  686. <span class="phpdocumentor-signature__name">M_FINDER_DOT</span>
  687. = <span class="phpdocumentor-signature__default-value">0b110000000000</span>
  688. </code>
  689. </article>
  690. <article class="phpdocumentor-element -constant -public ">
  691. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DOT_LIGHT">
  692. M_FINDER_DOT_LIGHT
  693. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT_LIGHT" class="headerlink"><i class="fas fa-link"></i></a>
  694. </h4>
  695. <aside class="phpdocumentor-element-found-in">
  696. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  697. :
  698. <span class="phpdocumentor-element-found-in__line">86</span>
  699. </aside>
  700. <code class="phpdocumentor-signature phpdocumentor-code ">
  701. <span class="phpdocumentor-signature__visibility">public</span>
  702. <span class="phpdocumentor-signature__type">int</span>
  703. <span class="phpdocumentor-signature__name">M_FINDER_DOT_LIGHT</span>
  704. = <span class="phpdocumentor-signature__default-value">0b10000000000</span>
  705. </code>
  706. </article>
  707. <article class="phpdocumentor-element -constant -public ">
  708. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT">
  709. M_FORMAT
  710. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT" class="headerlink"><i class="fas fa-link"></i></a>
  711. </h4>
  712. <aside class="phpdocumentor-element-found-in">
  713. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  714. :
  715. <span class="phpdocumentor-element-found-in__line">52</span>
  716. </aside>
  717. <code class="phpdocumentor-signature phpdocumentor-code ">
  718. <span class="phpdocumentor-signature__visibility">public</span>
  719. <span class="phpdocumentor-signature__type">int</span>
  720. <span class="phpdocumentor-signature__name">M_FORMAT</span>
  721. = <span class="phpdocumentor-signature__default-value">0b1000000</span>
  722. </code>
  723. </article>
  724. <article class="phpdocumentor-element -constant -public ">
  725. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT_DARK">
  726. M_FORMAT_DARK
  727. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  728. </h4>
  729. <aside class="phpdocumentor-element-found-in">
  730. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  731. :
  732. <span class="phpdocumentor-element-found-in__line">73</span>
  733. </aside>
  734. <code class="phpdocumentor-signature phpdocumentor-code ">
  735. <span class="phpdocumentor-signature__visibility">public</span>
  736. <span class="phpdocumentor-signature__type">int</span>
  737. <span class="phpdocumentor-signature__name">M_FORMAT_DARK</span>
  738. = <span class="phpdocumentor-signature__default-value">0b100001000000</span>
  739. </code>
  740. </article>
  741. <article class="phpdocumentor-element -constant -public ">
  742. <h4 class="phpdocumentor-element__name" id="constant_M_LOGO">
  743. M_LOGO
  744. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO" class="headerlink"><i class="fas fa-link"></i></a>
  745. </h4>
  746. <aside class="phpdocumentor-element-found-in">
  747. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  748. :
  749. <span class="phpdocumentor-element-found-in__line">33</span>
  750. </aside>
  751. <code class="phpdocumentor-signature phpdocumentor-code ">
  752. <span class="phpdocumentor-signature__visibility">public</span>
  753. <span class="phpdocumentor-signature__type">int</span>
  754. <span class="phpdocumentor-signature__name">M_LOGO</span>
  755. = <span class="phpdocumentor-signature__default-value">0b1000000000</span>
  756. </code>
  757. </article>
  758. <article class="phpdocumentor-element -constant -public ">
  759. <h4 class="phpdocumentor-element__name" id="constant_M_LOGO_DARK">
  760. M_LOGO_DARK
  761. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  762. </h4>
  763. <aside class="phpdocumentor-element-found-in">
  764. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  765. :
  766. <span class="phpdocumentor-element-found-in__line">35</span>
  767. </aside>
  768. <code class="phpdocumentor-signature phpdocumentor-code ">
  769. <span class="phpdocumentor-signature__visibility">public</span>
  770. <span class="phpdocumentor-signature__type">int</span>
  771. <span class="phpdocumentor-signature__name">M_LOGO_DARK</span>
  772. = <span class="phpdocumentor-signature__default-value">0b101000000000</span>
  773. </code>
  774. </article>
  775. <article class="phpdocumentor-element -constant -public ">
  776. <h4 class="phpdocumentor-element__name" id="constant_M_NULL">
  777. M_NULL
  778. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL" class="headerlink"><i class="fas fa-link"></i></a>
  779. </h4>
  780. <aside class="phpdocumentor-element-found-in">
  781. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  782. :
  783. <span class="phpdocumentor-element-found-in__line">31</span>
  784. </aside>
  785. <code class="phpdocumentor-signature phpdocumentor-code ">
  786. <span class="phpdocumentor-signature__visibility">public</span>
  787. <span class="phpdocumentor-signature__type">int</span>
  788. <span class="phpdocumentor-signature__name">M_NULL</span>
  789. = <span class="phpdocumentor-signature__default-value">0b0</span>
  790. </code>
  791. </article>
  792. <article class="phpdocumentor-element -constant -public ">
  793. <h4 class="phpdocumentor-element__name" id="constant_M_QUIETZONE">
  794. M_QUIETZONE
  795. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE" class="headerlink"><i class="fas fa-link"></i></a>
  796. </h4>
  797. <aside class="phpdocumentor-element-found-in">
  798. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  799. :
  800. <span class="phpdocumentor-element-found-in__line">56</span>
  801. </aside>
  802. <code class="phpdocumentor-signature phpdocumentor-code ">
  803. <span class="phpdocumentor-signature__visibility">public</span>
  804. <span class="phpdocumentor-signature__type">int</span>
  805. <span class="phpdocumentor-signature__name">M_QUIETZONE</span>
  806. = <span class="phpdocumentor-signature__default-value">0b100000000</span>
  807. </code>
  808. </article>
  809. <article class="phpdocumentor-element -constant -public ">
  810. <h4 class="phpdocumentor-element__name" id="constant_M_QUIETZONE_DARK">
  811. M_QUIETZONE_DARK
  812. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  813. </h4>
  814. <aside class="phpdocumentor-element-found-in">
  815. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  816. :
  817. <span class="phpdocumentor-element-found-in__line">90</span>
  818. </aside>
  819. <code class="phpdocumentor-signature phpdocumentor-code ">
  820. <span class="phpdocumentor-signature__visibility">public</span>
  821. <span class="phpdocumentor-signature__type">int</span>
  822. <span class="phpdocumentor-signature__name">M_QUIETZONE_DARK</span>
  823. = <span class="phpdocumentor-signature__default-value">0b100100000000</span>
  824. </code>
  825. </article>
  826. <article class="phpdocumentor-element -constant -public ">
  827. <h4 class="phpdocumentor-element__name" id="constant_M_SEPARATOR">
  828. M_SEPARATOR
  829. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR" class="headerlink"><i class="fas fa-link"></i></a>
  830. </h4>
  831. <aside class="phpdocumentor-element-found-in">
  832. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  833. :
  834. <span class="phpdocumentor-element-found-in__line">46</span>
  835. </aside>
  836. <code class="phpdocumentor-signature phpdocumentor-code ">
  837. <span class="phpdocumentor-signature__visibility">public</span>
  838. <span class="phpdocumentor-signature__type">int</span>
  839. <span class="phpdocumentor-signature__name">M_SEPARATOR</span>
  840. = <span class="phpdocumentor-signature__default-value">0b1000</span>
  841. </code>
  842. </article>
  843. <article class="phpdocumentor-element -constant -public ">
  844. <h4 class="phpdocumentor-element__name" id="constant_M_SEPARATOR_DARK">
  845. M_SEPARATOR_DARK
  846. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  847. </h4>
  848. <aside class="phpdocumentor-element-found-in">
  849. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  850. :
  851. <span class="phpdocumentor-element-found-in__line">88</span>
  852. </aside>
  853. <code class="phpdocumentor-signature phpdocumentor-code ">
  854. <span class="phpdocumentor-signature__visibility">public</span>
  855. <span class="phpdocumentor-signature__type">int</span>
  856. <span class="phpdocumentor-signature__name">M_SEPARATOR_DARK</span>
  857. = <span class="phpdocumentor-signature__default-value">0b100000001000</span>
  858. </code>
  859. </article>
  860. <article class="phpdocumentor-element -constant -public ">
  861. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING">
  862. M_TIMING
  863. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING" class="headerlink"><i class="fas fa-link"></i></a>
  864. </h4>
  865. <aside class="phpdocumentor-element-found-in">
  866. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  867. :
  868. <span class="phpdocumentor-element-found-in__line">50</span>
  869. </aside>
  870. <code class="phpdocumentor-signature phpdocumentor-code ">
  871. <span class="phpdocumentor-signature__visibility">public</span>
  872. <span class="phpdocumentor-signature__type">int</span>
  873. <span class="phpdocumentor-signature__name">M_TIMING</span>
  874. = <span class="phpdocumentor-signature__default-value">0b100000</span>
  875. </code>
  876. </article>
  877. <article class="phpdocumentor-element -constant -public ">
  878. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING_DARK">
  879. M_TIMING_DARK
  880. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  881. </h4>
  882. <aside class="phpdocumentor-element-found-in">
  883. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  884. :
  885. <span class="phpdocumentor-element-found-in__line">71</span>
  886. </aside>
  887. <code class="phpdocumentor-signature phpdocumentor-code ">
  888. <span class="phpdocumentor-signature__visibility">public</span>
  889. <span class="phpdocumentor-signature__type">int</span>
  890. <span class="phpdocumentor-signature__name">M_TIMING_DARK</span>
  891. = <span class="phpdocumentor-signature__default-value">0b100000100000</span>
  892. </code>
  893. </article>
  894. <article class="phpdocumentor-element -constant -public ">
  895. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION">
  896. M_VERSION
  897. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION" class="headerlink"><i class="fas fa-link"></i></a>
  898. </h4>
  899. <aside class="phpdocumentor-element-found-in">
  900. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  901. :
  902. <span class="phpdocumentor-element-found-in__line">54</span>
  903. </aside>
  904. <code class="phpdocumentor-signature phpdocumentor-code ">
  905. <span class="phpdocumentor-signature__visibility">public</span>
  906. <span class="phpdocumentor-signature__type">int</span>
  907. <span class="phpdocumentor-signature__name">M_VERSION</span>
  908. = <span class="phpdocumentor-signature__default-value">0b10000000</span>
  909. </code>
  910. </article>
  911. <article class="phpdocumentor-element -constant -public ">
  912. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION_DARK">
  913. M_VERSION_DARK
  914. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  915. </h4>
  916. <aside class="phpdocumentor-element-found-in">
  917. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  918. :
  919. <span class="phpdocumentor-element-found-in__line">75</span>
  920. </aside>
  921. <code class="phpdocumentor-signature phpdocumentor-code ">
  922. <span class="phpdocumentor-signature__visibility">public</span>
  923. <span class="phpdocumentor-signature__type">int</span>
  924. <span class="phpdocumentor-signature__name">M_VERSION_DARK</span>
  925. = <span class="phpdocumentor-signature__default-value">0b100010000000</span>
  926. </code>
  927. </article>
  928. <article class="phpdocumentor-element -constant -protected ">
  929. <h4 class="phpdocumentor-element__name" id="constant_neighbours">
  930. neighbours
  931. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours" class="headerlink"><i class="fas fa-link"></i></a>
  932. </h4>
  933. <aside class="phpdocumentor-element-found-in">
  934. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  935. :
  936. <span class="phpdocumentor-element-found-in__line">99</span>
  937. </aside>
  938. <p class="phpdocumentor-summary">Map of flag =&gt; coord</p>
  939. <code class="phpdocumentor-signature phpdocumentor-code ">
  940. <span class="phpdocumentor-signature__visibility">protected</span>
  941. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  942. <span class="phpdocumentor-signature__name">neighbours</span>
  943. = <span class="phpdocumentor-signature__default-value">[0b1 =&gt; [-1, -1], 0b10 =&gt; [0, -1], 0b100 =&gt; [1, -1], 0b1000 =&gt; [1, 0], 0b10000 =&gt; [1, 1], 0b100000 =&gt; [0, 1], 0b1000000 =&gt; [-1, 1], 0b10000000 =&gt; [-1, 0]]</span>
  944. </code>
  945. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  946. Tags
  947. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours#tags" class="headerlink"><i class="fas fa-link"></i></a>
  948. </h5>
  949. <dl class="phpdocumentor-tag-list">
  950. <dt class="phpdocumentor-tag-list__entry">
  951. <span class="phpdocumentor-tag__name">see</span>
  952. </dt>
  953. <dd class="phpdocumentor-tag-list__definition">
  954. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours"><abbr title="\chillerlan\QRCode\Data\QRMatrix::checkNeighbours()">QRMatrix::checkNeighbours()</abbr></a></span>
  955. </dd>
  956. </dl>
  957. </article>
  958. </section>
  959. <section class="phpdocumentor-properties">
  960. <h3 class="phpdocumentor-elements__header" id="properties">
  961. Properties
  962. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  963. </h3>
  964. <article
  965. class="
  966. phpdocumentor-element
  967. -property
  968. -protected
  969. "
  970. >
  971. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  972. $eccLevel
  973. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  974. <span class="phpdocumentor-element__modifiers">
  975. </span>
  976. </h4>
  977. <aside class="phpdocumentor-element-found-in">
  978. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  979. :
  980. <span class="phpdocumentor-element-found-in__line">118</span>
  981. </aside>
  982. <p class="phpdocumentor-summary">the current ECC level - always set in QRMatrix, may be null in BitMatrix</p>
  983. <code class="phpdocumentor-code phpdocumentor-signature ">
  984. <span class="phpdocumentor-signature__visibility">protected</span>
  985. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  986. <span class="phpdocumentor-signature__name">$eccLevel</span>
  987. = <span class="phpdocumentor-signature__default-value">null</span></code>
  988. </article>
  989. <article
  990. class="
  991. phpdocumentor-element
  992. -property
  993. -protected
  994. "
  995. >
  996. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  997. $maskPattern
  998. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  999. <span class="phpdocumentor-element__modifiers">
  1000. </span>
  1001. </h4>
  1002. <aside class="phpdocumentor-element-found-in">
  1003. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1004. :
  1005. <span class="phpdocumentor-element-found-in__line">127</span>
  1006. </aside>
  1007. <p class="phpdocumentor-summary">the mask pattern that was used in the most recent operation, set via:</p>
  1008. <code class="phpdocumentor-code phpdocumentor-signature ">
  1009. <span class="phpdocumentor-signature__visibility">protected</span>
  1010. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  1011. <span class="phpdocumentor-signature__name">$maskPattern</span>
  1012. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1013. <section class="phpdocumentor-description"><ul>
  1014. <li>QRMatrix::setFormatInfo()</li>
  1015. <li>QRMatrix::mask()</li>
  1016. <li>BitMatrix::readFormatInformation()</li>
  1017. </ul>
  1018. </section>
  1019. </article>
  1020. <article
  1021. class="
  1022. phpdocumentor-element
  1023. -property
  1024. -protected
  1025. "
  1026. >
  1027. <h4 class="phpdocumentor-element__name" id="property_matrix">
  1028. $matrix
  1029. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  1030. <span class="phpdocumentor-element__modifiers">
  1031. </span>
  1032. </h4>
  1033. <aside class="phpdocumentor-element-found-in">
  1034. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1035. :
  1036. <span class="phpdocumentor-element-found-in__line">139</span>
  1037. </aside>
  1038. <p class="phpdocumentor-summary">the actual matrix data array</p>
  1039. <code class="phpdocumentor-code phpdocumentor-signature ">
  1040. <span class="phpdocumentor-signature__visibility">protected</span>
  1041. <span class="phpdocumentor-signature__type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span>
  1042. <span class="phpdocumentor-signature__name">$matrix</span>
  1043. </code>
  1044. </article>
  1045. <article
  1046. class="
  1047. phpdocumentor-element
  1048. -property
  1049. -protected
  1050. "
  1051. >
  1052. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  1053. $moduleCount
  1054. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  1055. <span class="phpdocumentor-element__modifiers">
  1056. </span>
  1057. </h4>
  1058. <aside class="phpdocumentor-element-found-in">
  1059. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1060. :
  1061. <span class="phpdocumentor-element-found-in__line">132</span>
  1062. </aside>
  1063. <p class="phpdocumentor-summary">the size (side length) of the matrix, including quiet zone (if created)</p>
  1064. <code class="phpdocumentor-code phpdocumentor-signature ">
  1065. <span class="phpdocumentor-signature__visibility">protected</span>
  1066. <span class="phpdocumentor-signature__type">int</span>
  1067. <span class="phpdocumentor-signature__name">$moduleCount</span>
  1068. </code>
  1069. </article>
  1070. <article
  1071. class="
  1072. phpdocumentor-element
  1073. -property
  1074. -protected
  1075. "
  1076. >
  1077. <h4 class="phpdocumentor-element__name" id="property_version">
  1078. $version
  1079. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  1080. <span class="phpdocumentor-element__modifiers">
  1081. </span>
  1082. </h4>
  1083. <aside class="phpdocumentor-element-found-in">
  1084. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1085. :
  1086. <span class="phpdocumentor-element-found-in__line">113</span>
  1087. </aside>
  1088. <p class="phpdocumentor-summary">the matrix version - always set in QRMatrix, may be null in BitMatrix</p>
  1089. <code class="phpdocumentor-code phpdocumentor-signature ">
  1090. <span class="phpdocumentor-signature__visibility">protected</span>
  1091. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  1092. <span class="phpdocumentor-signature__name">$version</span>
  1093. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1094. </article>
  1095. </section>
  1096. <section class="phpdocumentor-methods">
  1097. <h3 class="phpdocumentor-elements__header" id="methods">
  1098. Methods
  1099. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  1100. </h3>
  1101. <article
  1102. class="phpdocumentor-element
  1103. -method
  1104. -public
  1105. "
  1106. >
  1107. <h4 class="phpdocumentor-element__name" id="method___construct">
  1108. __construct()
  1109. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  1110. </h4>
  1111. <aside class="phpdocumentor-element-found-in">
  1112. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1113. :
  1114. <span class="phpdocumentor-element-found-in__line">144</span>
  1115. </aside>
  1116. <p class="phpdocumentor-summary">QRMatrix constructor.</p>
  1117. <code class="phpdocumentor-code phpdocumentor-signature ">
  1118. <span class="phpdocumentor-signature__visibility">public</span>
  1119. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$eccLevel</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  1120. <div class="phpdocumentor-label-line">
  1121. </div>
  1122. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1123. <dl class="phpdocumentor-argument-list">
  1124. <dt class="phpdocumentor-argument-list__entry">
  1125. <span class="phpdocumentor-signature__argument__name">$version</span>
  1126. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  1127. </dt>
  1128. <dd class="phpdocumentor-argument-list__definition">
  1129. </dd>
  1130. <dt class="phpdocumentor-argument-list__entry">
  1131. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  1132. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  1133. </dt>
  1134. <dd class="phpdocumentor-argument-list__definition">
  1135. </dd>
  1136. </dl>
  1137. </article>
  1138. <article
  1139. class="phpdocumentor-element
  1140. -method
  1141. -public
  1142. "
  1143. >
  1144. <h4 class="phpdocumentor-element__name" id="method_check">
  1145. check()
  1146. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check" class="headerlink"><i class="fas fa-link"></i></a>
  1147. </h4>
  1148. <aside class="phpdocumentor-element-found-in">
  1149. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1150. :
  1151. <span class="phpdocumentor-element-found-in__line">358</span>
  1152. </aside>
  1153. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is true (dark) or false (light)</p>
  1154. <code class="phpdocumentor-code phpdocumentor-signature ">
  1155. <span class="phpdocumentor-signature__visibility">public</span>
  1156. <span class="phpdocumentor-signature__name">check</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">bool</span></code>
  1157. <div class="phpdocumentor-label-line">
  1158. </div>
  1159. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1160. <dl class="phpdocumentor-argument-list">
  1161. <dt class="phpdocumentor-argument-list__entry">
  1162. <span class="phpdocumentor-signature__argument__name">$x</span>
  1163. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1164. </dt>
  1165. <dd class="phpdocumentor-argument-list__definition">
  1166. </dd>
  1167. <dt class="phpdocumentor-argument-list__entry">
  1168. <span class="phpdocumentor-signature__argument__name">$y</span>
  1169. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1170. </dt>
  1171. <dd class="phpdocumentor-argument-list__definition">
  1172. </dd>
  1173. </dl>
  1174. <section>
  1175. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1176. <span class="phpdocumentor-signature__response_type">bool</span>
  1177. </section>
  1178. </article>
  1179. <article
  1180. class="phpdocumentor-element
  1181. -method
  1182. -public
  1183. "
  1184. >
  1185. <h4 class="phpdocumentor-element__name" id="method_checkNeighbours">
  1186. checkNeighbours()
  1187. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours" class="headerlink"><i class="fas fa-link"></i></a>
  1188. </h4>
  1189. <aside class="phpdocumentor-element-found-in">
  1190. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1191. :
  1192. <span class="phpdocumentor-element-found-in__line">372</span>
  1193. </aside>
  1194. <p class="phpdocumentor-summary">Checks the status of the neighbouring modules for the module at ($x, $y) and returns a bitmask with the results.</p>
  1195. <code class="phpdocumentor-code phpdocumentor-signature ">
  1196. <span class="phpdocumentor-signature__visibility">public</span>
  1197. <span class="phpdocumentor-signature__name">checkNeighbours</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>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1198. <div class="phpdocumentor-label-line">
  1199. </div>
  1200. <section class="phpdocumentor-description"><p>The 8 flags of the bitmask represent the status of each of the neighbouring fields,
  1201. starting with the lowest bit for top left, going clockwise:</p>
  1202. <p>0 1 2
  1203. 7 # 3
  1204. 6 5 4</p>
  1205. </section>
  1206. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1207. <dl class="phpdocumentor-argument-list">
  1208. <dt class="phpdocumentor-argument-list__entry">
  1209. <span class="phpdocumentor-signature__argument__name">$x</span>
  1210. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1211. </dt>
  1212. <dd class="phpdocumentor-argument-list__definition">
  1213. </dd>
  1214. <dt class="phpdocumentor-argument-list__entry">
  1215. <span class="phpdocumentor-signature__argument__name">$y</span>
  1216. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1217. </dt>
  1218. <dd class="phpdocumentor-argument-list__definition">
  1219. </dd>
  1220. <dt class="phpdocumentor-argument-list__entry">
  1221. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1222. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1223. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1224. <dd class="phpdocumentor-argument-list__definition">
  1225. </dd>
  1226. </dl>
  1227. <section>
  1228. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1229. <span class="phpdocumentor-signature__response_type">int</span>
  1230. </section>
  1231. </article>
  1232. <article
  1233. class="phpdocumentor-element
  1234. -method
  1235. -public
  1236. "
  1237. >
  1238. <h4 class="phpdocumentor-element__name" id="method_checkType">
  1239. checkType()
  1240. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType" class="headerlink"><i class="fas fa-link"></i></a>
  1241. </h4>
  1242. <aside class="phpdocumentor-element-found-in">
  1243. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1244. :
  1245. <span class="phpdocumentor-element-found-in__line">330</span>
  1246. </aside>
  1247. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is of the given $M_TYPE</p>
  1248. <code class="phpdocumentor-code phpdocumentor-signature ">
  1249. <span class="phpdocumentor-signature__visibility">public</span>
  1250. <span class="phpdocumentor-signature__name">checkType</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">bool</span></code>
  1251. <div class="phpdocumentor-label-line">
  1252. </div>
  1253. <section class="phpdocumentor-description"><p>true =&gt; $value &amp; $M_TYPE === $M_TYPE</p>
  1254. </section>
  1255. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1256. <dl class="phpdocumentor-argument-list">
  1257. <dt class="phpdocumentor-argument-list__entry">
  1258. <span class="phpdocumentor-signature__argument__name">$x</span>
  1259. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1260. </dt>
  1261. <dd class="phpdocumentor-argument-list__definition">
  1262. </dd>
  1263. <dt class="phpdocumentor-argument-list__entry">
  1264. <span class="phpdocumentor-signature__argument__name">$y</span>
  1265. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1266. </dt>
  1267. <dd class="phpdocumentor-argument-list__definition">
  1268. </dd>
  1269. <dt class="phpdocumentor-argument-list__entry">
  1270. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1271. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1272. </dt>
  1273. <dd class="phpdocumentor-argument-list__definition">
  1274. </dd>
  1275. </dl>
  1276. <section>
  1277. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1278. <span class="phpdocumentor-signature__response_type">bool</span>
  1279. </section>
  1280. </article>
  1281. <article
  1282. class="phpdocumentor-element
  1283. -method
  1284. -public
  1285. "
  1286. >
  1287. <h4 class="phpdocumentor-element__name" id="method_checkTypeIn">
  1288. checkTypeIn()
  1289. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn" class="headerlink"><i class="fas fa-link"></i></a>
  1290. </h4>
  1291. <aside class="phpdocumentor-element-found-in">
  1292. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1293. :
  1294. <span class="phpdocumentor-element-found-in__line">344</span>
  1295. </aside>
  1296. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is in the given array of $M_TYPES,
  1297. returns true if a match is found, otherwise false.</p>
  1298. <code class="phpdocumentor-code phpdocumentor-signature ">
  1299. <span class="phpdocumentor-signature__visibility">public</span>
  1300. <span class="phpdocumentor-signature__name">checkTypeIn</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">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPES</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1301. <div class="phpdocumentor-label-line">
  1302. </div>
  1303. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1304. <dl class="phpdocumentor-argument-list">
  1305. <dt class="phpdocumentor-argument-list__entry">
  1306. <span class="phpdocumentor-signature__argument__name">$x</span>
  1307. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1308. </dt>
  1309. <dd class="phpdocumentor-argument-list__definition">
  1310. </dd>
  1311. <dt class="phpdocumentor-argument-list__entry">
  1312. <span class="phpdocumentor-signature__argument__name">$y</span>
  1313. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1314. </dt>
  1315. <dd class="phpdocumentor-argument-list__definition">
  1316. </dd>
  1317. <dt class="phpdocumentor-argument-list__entry">
  1318. <span class="phpdocumentor-signature__argument__name">$M_TYPES</span>
  1319. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1320. </dt>
  1321. <dd class="phpdocumentor-argument-list__definition">
  1322. </dd>
  1323. </dl>
  1324. <section>
  1325. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1326. <span class="phpdocumentor-signature__response_type">bool</span>
  1327. </section>
  1328. </article>
  1329. <article
  1330. class="phpdocumentor-element
  1331. -method
  1332. -public
  1333. -deprecated "
  1334. >
  1335. <h4 class="phpdocumentor-element__name" id="method_eccLevel">
  1336. eccLevel()
  1337. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1338. </h4>
  1339. <aside class="phpdocumentor-element-found-in">
  1340. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1341. :
  1342. <span class="phpdocumentor-element-found-in__line">234</span>
  1343. </aside>
  1344. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1345. <span class="phpdocumentor-signature__visibility">public</span>
  1346. <span class="phpdocumentor-signature__name">eccLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span></code>
  1347. <div class="phpdocumentor-label-line">
  1348. </div>
  1349. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1350. Tags
  1351. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1352. </h5>
  1353. <dl class="phpdocumentor-tag-list">
  1354. <dt class="phpdocumentor-tag-list__entry">
  1355. <span class="phpdocumentor-tag__name">deprecated</span>
  1356. </dt>
  1357. <dd class="phpdocumentor-tag-list__definition">
  1358. <span class="phpdocumentor-tag-link">5.0.0</span>
  1359. <section class="phpdocumentor-description"><p>use QRMatrix::getEccLevel() instead</p>
  1360. </section>
  1361. </dd>
  1362. <dt class="phpdocumentor-tag-list__entry">
  1363. <span class="phpdocumentor-tag__name">see</span>
  1364. </dt>
  1365. <dd class="phpdocumentor-tag-list__definition">
  1366. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getEccLevel()">QRMatrix::getEccLevel()</abbr></a></span>
  1367. </dd>
  1368. <dt class="phpdocumentor-tag-list__entry">
  1369. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1370. </dt>
  1371. <dd class="phpdocumentor-tag-list__definition">
  1372. </dd>
  1373. </dl>
  1374. <section>
  1375. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1376. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  1377. </section>
  1378. </article>
  1379. <article
  1380. class="phpdocumentor-element
  1381. -method
  1382. -public
  1383. "
  1384. >
  1385. <h4 class="phpdocumentor-element__name" id="method_flip">
  1386. flip()
  1387. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip" class="headerlink"><i class="fas fa-link"></i></a>
  1388. </h4>
  1389. <aside class="phpdocumentor-element-found-in">
  1390. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1391. :
  1392. <span class="phpdocumentor-element-found-in__line">316</span>
  1393. </aside>
  1394. <p class="phpdocumentor-summary">Flips the value of the module at ($x, $y)</p>
  1395. <code class="phpdocumentor-code phpdocumentor-signature ">
  1396. <span class="phpdocumentor-signature__visibility">public</span>
  1397. <span class="phpdocumentor-signature__name">flip</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">self</span></code>
  1398. <div class="phpdocumentor-label-line">
  1399. </div>
  1400. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1401. <dl class="phpdocumentor-argument-list">
  1402. <dt class="phpdocumentor-argument-list__entry">
  1403. <span class="phpdocumentor-signature__argument__name">$x</span>
  1404. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1405. </dt>
  1406. <dd class="phpdocumentor-argument-list__definition">
  1407. </dd>
  1408. <dt class="phpdocumentor-argument-list__entry">
  1409. <span class="phpdocumentor-signature__argument__name">$y</span>
  1410. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1411. </dt>
  1412. <dd class="phpdocumentor-argument-list__definition">
  1413. </dd>
  1414. </dl>
  1415. <section>
  1416. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1417. <span class="phpdocumentor-signature__response_type">self</span>
  1418. </section>
  1419. </article>
  1420. <article
  1421. class="phpdocumentor-element
  1422. -method
  1423. -public
  1424. "
  1425. >
  1426. <h4 class="phpdocumentor-element__name" id="method_get">
  1427. get()
  1428. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
  1429. </h4>
  1430. <aside class="phpdocumentor-element-found-in">
  1431. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1432. :
  1433. <span class="phpdocumentor-element-found-in__line">275</span>
  1434. </aside>
  1435. <p class="phpdocumentor-summary">Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix</p>
  1436. <code class="phpdocumentor-code phpdocumentor-signature ">
  1437. <span class="phpdocumentor-signature__visibility">public</span>
  1438. <span class="phpdocumentor-signature__name">get</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">int</span></code>
  1439. <div class="phpdocumentor-label-line">
  1440. </div>
  1441. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1442. <dl class="phpdocumentor-argument-list">
  1443. <dt class="phpdocumentor-argument-list__entry">
  1444. <span class="phpdocumentor-signature__argument__name">$x</span>
  1445. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1446. </dt>
  1447. <dd class="phpdocumentor-argument-list__definition">
  1448. </dd>
  1449. <dt class="phpdocumentor-argument-list__entry">
  1450. <span class="phpdocumentor-signature__argument__name">$y</span>
  1451. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1452. </dt>
  1453. <dd class="phpdocumentor-argument-list__definition">
  1454. </dd>
  1455. </dl>
  1456. <section>
  1457. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1458. <span class="phpdocumentor-signature__response_type">int</span>
  1459. </section>
  1460. </article>
  1461. <article
  1462. class="phpdocumentor-element
  1463. -method
  1464. -public
  1465. "
  1466. >
  1467. <h4 class="phpdocumentor-element__name" id="method_getEccLevel">
  1468. getEccLevel()
  1469. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1470. </h4>
  1471. <aside class="phpdocumentor-element-found-in">
  1472. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1473. :
  1474. <span class="phpdocumentor-element-found-in__line">225</span>
  1475. </aside>
  1476. <p class="phpdocumentor-summary">Returns the current ECC level</p>
  1477. <code class="phpdocumentor-code phpdocumentor-signature ">
  1478. <span class="phpdocumentor-signature__visibility">public</span>
  1479. <span class="phpdocumentor-signature__name">getEccLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span></code>
  1480. <div class="phpdocumentor-label-line">
  1481. </div>
  1482. <section>
  1483. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1484. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  1485. </section>
  1486. </article>
  1487. <article
  1488. class="phpdocumentor-element
  1489. -method
  1490. -public
  1491. "
  1492. >
  1493. <h4 class="phpdocumentor-element__name" id="method_getMaskPattern">
  1494. getMaskPattern()
  1495. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1496. </h4>
  1497. <aside class="phpdocumentor-element-found-in">
  1498. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1499. :
  1500. <span class="phpdocumentor-element-found-in__line">241</span>
  1501. </aside>
  1502. <p class="phpdocumentor-summary">Returns the current mask pattern</p>
  1503. <code class="phpdocumentor-code phpdocumentor-signature ">
  1504. <span class="phpdocumentor-signature__visibility">public</span>
  1505. <span class="phpdocumentor-signature__name">getMaskPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span></code>
  1506. <div class="phpdocumentor-label-line">
  1507. </div>
  1508. <section>
  1509. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1510. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  1511. </section>
  1512. </article>
  1513. <article
  1514. class="phpdocumentor-element
  1515. -method
  1516. -public
  1517. "
  1518. >
  1519. <h4 class="phpdocumentor-element__name" id="method_getMatrix">
  1520. getMatrix()
  1521. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  1522. </h4>
  1523. <aside class="phpdocumentor-element-found-in">
  1524. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1525. :
  1526. <span class="phpdocumentor-element-found-in__line">178</span>
  1527. </aside>
  1528. <p class="phpdocumentor-summary">Returns the data matrix, returns a pure boolean representation if $boolean is set to true</p>
  1529. <code class="phpdocumentor-code phpdocumentor-signature ">
  1530. <span class="phpdocumentor-signature__visibility">public</span>
  1531. <span class="phpdocumentor-signature__name">getMatrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$boolean</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span></code>
  1532. <div class="phpdocumentor-label-line">
  1533. </div>
  1534. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1535. <dl class="phpdocumentor-argument-list">
  1536. <dt class="phpdocumentor-argument-list__entry">
  1537. <span class="phpdocumentor-signature__argument__name">$boolean</span>
  1538. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1539. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1540. <dd class="phpdocumentor-argument-list__definition">
  1541. </dd>
  1542. </dl>
  1543. <section>
  1544. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1545. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span>
  1546. </section>
  1547. </article>
  1548. <article
  1549. class="phpdocumentor-element
  1550. -method
  1551. -public
  1552. "
  1553. >
  1554. <h4 class="phpdocumentor-element__name" id="method_getSize">
  1555. getSize()
  1556. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize" class="headerlink"><i class="fas fa-link"></i></a>
  1557. </h4>
  1558. <aside class="phpdocumentor-element-found-in">
  1559. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1560. :
  1561. <span class="phpdocumentor-element-found-in__line">259</span>
  1562. </aside>
  1563. <p class="phpdocumentor-summary">Returns the absoulute size of the matrix, including quiet zone (after setting it).</p>
  1564. <code class="phpdocumentor-code phpdocumentor-signature ">
  1565. <span class="phpdocumentor-signature__visibility">public</span>
  1566. <span class="phpdocumentor-signature__name">getSize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1567. <div class="phpdocumentor-label-line">
  1568. </div>
  1569. <section class="phpdocumentor-description"><p>size = version * 4 + 17 [ + 2 * quietzone size]</p>
  1570. </section>
  1571. <section>
  1572. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1573. <span class="phpdocumentor-signature__response_type">int</span>
  1574. </section>
  1575. </article>
  1576. <article
  1577. class="phpdocumentor-element
  1578. -method
  1579. -public
  1580. "
  1581. >
  1582. <h4 class="phpdocumentor-element__name" id="method_getVersion">
  1583. getVersion()
  1584. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion" class="headerlink"><i class="fas fa-link"></i></a>
  1585. </h4>
  1586. <aside class="phpdocumentor-element-found-in">
  1587. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1588. :
  1589. <span class="phpdocumentor-element-found-in__line">209</span>
  1590. </aside>
  1591. <p class="phpdocumentor-summary">Returns the current version number</p>
  1592. <code class="phpdocumentor-code phpdocumentor-signature ">
  1593. <span class="phpdocumentor-signature__visibility">public</span>
  1594. <span class="phpdocumentor-signature__name">getVersion</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span></code>
  1595. <div class="phpdocumentor-label-line">
  1596. </div>
  1597. <section>
  1598. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1599. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  1600. </section>
  1601. </article>
  1602. <article
  1603. class="phpdocumentor-element
  1604. -method
  1605. -public
  1606. "
  1607. >
  1608. <h4 class="phpdocumentor-element__name" id="method_initFunctionalPatterns">
  1609. initFunctionalPatterns()
  1610. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns" class="headerlink"><i class="fas fa-link"></i></a>
  1611. </h4>
  1612. <aside class="phpdocumentor-element-found-in">
  1613. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1614. :
  1615. <span class="phpdocumentor-element-found-in__line">161</span>
  1616. </aside>
  1617. <p class="phpdocumentor-summary">shortcut to initialize the functional patterns</p>
  1618. <code class="phpdocumentor-code phpdocumentor-signature ">
  1619. <span class="phpdocumentor-signature__visibility">public</span>
  1620. <span class="phpdocumentor-signature__name">initFunctionalPatterns</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1621. <div class="phpdocumentor-label-line">
  1622. </div>
  1623. <section>
  1624. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1625. <span class="phpdocumentor-signature__response_type">self</span>
  1626. </section>
  1627. </article>
  1628. <article
  1629. class="phpdocumentor-element
  1630. -method
  1631. -public
  1632. "
  1633. >
  1634. <h4 class="phpdocumentor-element__name" id="method_invert">
  1635. invert()
  1636. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_invert" class="headerlink"><i class="fas fa-link"></i></a>
  1637. </h4>
  1638. <aside class="phpdocumentor-element-found-in">
  1639. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1640. :
  1641. <span class="phpdocumentor-element-found-in__line">618</span>
  1642. </aside>
  1643. <p class="phpdocumentor-summary">Inverts the values of the whole matrix</p>
  1644. <code class="phpdocumentor-code phpdocumentor-signature ">
  1645. <span class="phpdocumentor-signature__visibility">public</span>
  1646. <span class="phpdocumentor-signature__name">invert</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1647. <div class="phpdocumentor-label-line">
  1648. </div>
  1649. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2015 Section 6.2 - Reflectance reversal</p>
  1650. </section>
  1651. <section>
  1652. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1653. <span class="phpdocumentor-signature__response_type">self</span>
  1654. </section>
  1655. </article>
  1656. <article
  1657. class="phpdocumentor-element
  1658. -method
  1659. -public
  1660. "
  1661. >
  1662. <h4 class="phpdocumentor-element__name" id="method_mask">
  1663. mask()
  1664. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask" class="headerlink"><i class="fas fa-link"></i></a>
  1665. </h4>
  1666. <aside class="phpdocumentor-element-found-in">
  1667. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1668. :
  1669. <span class="phpdocumentor-element-found-in__line">767</span>
  1670. </aside>
  1671. <p class="phpdocumentor-summary">Applies/reverses the mask pattern</p>
  1672. <code class="phpdocumentor-code phpdocumentor-signature ">
  1673. <span class="phpdocumentor-signature__visibility">public</span>
  1674. <span class="phpdocumentor-signature__name">mask</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1675. <div class="phpdocumentor-label-line">
  1676. </div>
  1677. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.8.1</p>
  1678. </section>
  1679. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1680. <dl class="phpdocumentor-argument-list">
  1681. <dt class="phpdocumentor-argument-list__entry">
  1682. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1683. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
  1684. </dt>
  1685. <dd class="phpdocumentor-argument-list__definition">
  1686. </dd>
  1687. </dl>
  1688. <section>
  1689. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1690. <span class="phpdocumentor-signature__response_type">self</span>
  1691. </section>
  1692. </article>
  1693. <article
  1694. class="phpdocumentor-element
  1695. -method
  1696. -public
  1697. -deprecated "
  1698. >
  1699. <h4 class="phpdocumentor-element__name" id="method_maskPattern">
  1700. maskPattern()
  1701. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1702. </h4>
  1703. <aside class="phpdocumentor-element-found-in">
  1704. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1705. :
  1706. <span class="phpdocumentor-element-found-in__line">250</span>
  1707. </aside>
  1708. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1709. <span class="phpdocumentor-signature__visibility">public</span>
  1710. <span class="phpdocumentor-signature__name">maskPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span></code>
  1711. <div class="phpdocumentor-label-line">
  1712. </div>
  1713. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1714. Tags
  1715. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1716. </h5>
  1717. <dl class="phpdocumentor-tag-list">
  1718. <dt class="phpdocumentor-tag-list__entry">
  1719. <span class="phpdocumentor-tag__name">deprecated</span>
  1720. </dt>
  1721. <dd class="phpdocumentor-tag-list__definition">
  1722. <span class="phpdocumentor-tag-link">5.0.0</span>
  1723. <section class="phpdocumentor-description"><p>use QRMatrix::getMaskPattern() instead</p>
  1724. </section>
  1725. </dd>
  1726. <dt class="phpdocumentor-tag-list__entry">
  1727. <span class="phpdocumentor-tag__name">see</span>
  1728. </dt>
  1729. <dd class="phpdocumentor-tag-list__definition">
  1730. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getMaskPattern()">QRMatrix::getMaskPattern()</abbr></a></span>
  1731. </dd>
  1732. <dt class="phpdocumentor-tag-list__entry">
  1733. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1734. </dt>
  1735. <dd class="phpdocumentor-tag-list__definition">
  1736. </dd>
  1737. </dl>
  1738. <section>
  1739. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1740. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  1741. </section>
  1742. </article>
  1743. <article
  1744. class="phpdocumentor-element
  1745. -method
  1746. -public
  1747. -deprecated "
  1748. >
  1749. <h4 class="phpdocumentor-element__name" id="method_matrix">
  1750. matrix()
  1751. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  1752. </h4>
  1753. <aside class="phpdocumentor-element-found-in">
  1754. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1755. :
  1756. <span class="phpdocumentor-element-found-in__line">202</span>
  1757. </aside>
  1758. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1759. <span class="phpdocumentor-signature__visibility">public</span>
  1760. <span class="phpdocumentor-signature__name">matrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$boolean</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1761. <div class="phpdocumentor-label-line">
  1762. </div>
  1763. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1764. <dl class="phpdocumentor-argument-list">
  1765. <dt class="phpdocumentor-argument-list__entry">
  1766. <span class="phpdocumentor-signature__argument__name">$boolean</span>
  1767. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1768. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1769. <dd class="phpdocumentor-argument-list__definition">
  1770. </dd>
  1771. </dl>
  1772. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1773. Tags
  1774. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1775. </h5>
  1776. <dl class="phpdocumentor-tag-list">
  1777. <dt class="phpdocumentor-tag-list__entry">
  1778. <span class="phpdocumentor-tag__name">deprecated</span>
  1779. </dt>
  1780. <dd class="phpdocumentor-tag-list__definition">
  1781. <span class="phpdocumentor-tag-link">5.0.0</span>
  1782. <section class="phpdocumentor-description"><p>use QRMatrix::getMatrix() instead</p>
  1783. </section>
  1784. </dd>
  1785. <dt class="phpdocumentor-tag-list__entry">
  1786. <span class="phpdocumentor-tag__name">see</span>
  1787. </dt>
  1788. <dd class="phpdocumentor-tag-list__definition">
  1789. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getMatrix()">QRMatrix::getMatrix()</abbr></a></span>
  1790. </dd>
  1791. <dt class="phpdocumentor-tag-list__entry">
  1792. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1793. </dt>
  1794. <dd class="phpdocumentor-tag-list__definition">
  1795. </dd>
  1796. </dl>
  1797. <section>
  1798. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1799. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1800. </section>
  1801. </article>
  1802. <article
  1803. class="phpdocumentor-element
  1804. -method
  1805. -public
  1806. "
  1807. >
  1808. <h4 class="phpdocumentor-element__name" id="method_rotate90">
  1809. rotate90()
  1810. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_rotate90" class="headerlink"><i class="fas fa-link"></i></a>
  1811. </h4>
  1812. <aside class="phpdocumentor-element-found-in">
  1813. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1814. :
  1815. <span class="phpdocumentor-element-found-in__line">606</span>
  1816. </aside>
  1817. <p class="phpdocumentor-summary">Rotates the matrix by 90 degrees clock wise</p>
  1818. <code class="phpdocumentor-code phpdocumentor-signature ">
  1819. <span class="phpdocumentor-signature__visibility">public</span>
  1820. <span class="phpdocumentor-signature__name">rotate90</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1821. <div class="phpdocumentor-label-line">
  1822. </div>
  1823. <section>
  1824. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1825. <span class="phpdocumentor-signature__response_type">self</span>
  1826. </section>
  1827. </article>
  1828. <article
  1829. class="phpdocumentor-element
  1830. -method
  1831. -public
  1832. "
  1833. >
  1834. <h4 class="phpdocumentor-element__name" id="method_set">
  1835. set()
  1836. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
  1837. </h4>
  1838. <aside class="phpdocumentor-element-found-in">
  1839. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1840. :
  1841. <span class="phpdocumentor-element-found-in__line">290</span>
  1842. </aside>
  1843. <p class="phpdocumentor-summary">Sets the $M_TYPE value for the module at position [$x, $y]</p>
  1844. <code class="phpdocumentor-code phpdocumentor-signature ">
  1845. <span class="phpdocumentor-signature__visibility">public</span>
  1846. <span class="phpdocumentor-signature__name">set</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">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</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">self</span></code>
  1847. <div class="phpdocumentor-label-line">
  1848. </div>
  1849. <section class="phpdocumentor-description"><p>true =&gt; $M_TYPE | 0x800
  1850. false =&gt; $M_TYPE</p>
  1851. </section>
  1852. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1853. <dl class="phpdocumentor-argument-list">
  1854. <dt class="phpdocumentor-argument-list__entry">
  1855. <span class="phpdocumentor-signature__argument__name">$x</span>
  1856. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1857. </dt>
  1858. <dd class="phpdocumentor-argument-list__definition">
  1859. </dd>
  1860. <dt class="phpdocumentor-argument-list__entry">
  1861. <span class="phpdocumentor-signature__argument__name">$y</span>
  1862. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1863. </dt>
  1864. <dd class="phpdocumentor-argument-list__definition">
  1865. </dd>
  1866. <dt class="phpdocumentor-argument-list__entry">
  1867. <span class="phpdocumentor-signature__argument__name">$value</span>
  1868. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1869. </dt>
  1870. <dd class="phpdocumentor-argument-list__definition">
  1871. </dd>
  1872. <dt class="phpdocumentor-argument-list__entry">
  1873. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1874. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1875. </dt>
  1876. <dd class="phpdocumentor-argument-list__definition">
  1877. </dd>
  1878. </dl>
  1879. <section>
  1880. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1881. <span class="phpdocumentor-signature__response_type">self</span>
  1882. </section>
  1883. </article>
  1884. <article
  1885. class="phpdocumentor-element
  1886. -method
  1887. -public
  1888. "
  1889. >
  1890. <h4 class="phpdocumentor-element__name" id="method_setAlignmentPattern">
  1891. setAlignmentPattern()
  1892. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1893. </h4>
  1894. <aside class="phpdocumentor-element-found-in">
  1895. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1896. :
  1897. <span class="phpdocumentor-element-found-in__line">462</span>
  1898. </aside>
  1899. <p class="phpdocumentor-summary">Draws the 5x5 alignment patterns</p>
  1900. <code class="phpdocumentor-code phpdocumentor-signature ">
  1901. <span class="phpdocumentor-signature__visibility">public</span>
  1902. <span class="phpdocumentor-signature__name">setAlignmentPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1903. <div class="phpdocumentor-label-line">
  1904. </div>
  1905. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.5</p>
  1906. </section>
  1907. <section>
  1908. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1909. <span class="phpdocumentor-signature__response_type">self</span>
  1910. </section>
  1911. </article>
  1912. <article
  1913. class="phpdocumentor-element
  1914. -method
  1915. -public
  1916. "
  1917. >
  1918. <h4 class="phpdocumentor-element__name" id="method_setArea">
  1919. setArea()
  1920. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setArea" class="headerlink"><i class="fas fa-link"></i></a>
  1921. </h4>
  1922. <aside class="phpdocumentor-element-found-in">
  1923. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1924. :
  1925. <span class="phpdocumentor-element-found-in__line">302</span>
  1926. </aside>
  1927. <p class="phpdocumentor-summary">Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.</p>
  1928. <code class="phpdocumentor-code phpdocumentor-signature ">
  1929. <span class="phpdocumentor-signature__visibility">public</span>
  1930. <span class="phpdocumentor-signature__name">setArea</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startX</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">$startY</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">$width</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">$height</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</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">self</span></code>
  1931. <div class="phpdocumentor-label-line">
  1932. </div>
  1933. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1934. <dl class="phpdocumentor-argument-list">
  1935. <dt class="phpdocumentor-argument-list__entry">
  1936. <span class="phpdocumentor-signature__argument__name">$startX</span>
  1937. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1938. </dt>
  1939. <dd class="phpdocumentor-argument-list__definition">
  1940. </dd>
  1941. <dt class="phpdocumentor-argument-list__entry">
  1942. <span class="phpdocumentor-signature__argument__name">$startY</span>
  1943. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1944. </dt>
  1945. <dd class="phpdocumentor-argument-list__definition">
  1946. </dd>
  1947. <dt class="phpdocumentor-argument-list__entry">
  1948. <span class="phpdocumentor-signature__argument__name">$width</span>
  1949. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1950. </dt>
  1951. <dd class="phpdocumentor-argument-list__definition">
  1952. </dd>
  1953. <dt class="phpdocumentor-argument-list__entry">
  1954. <span class="phpdocumentor-signature__argument__name">$height</span>
  1955. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1956. </dt>
  1957. <dd class="phpdocumentor-argument-list__definition">
  1958. </dd>
  1959. <dt class="phpdocumentor-argument-list__entry">
  1960. <span class="phpdocumentor-signature__argument__name">$value</span>
  1961. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1962. </dt>
  1963. <dd class="phpdocumentor-argument-list__definition">
  1964. </dd>
  1965. <dt class="phpdocumentor-argument-list__entry">
  1966. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1967. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1968. </dt>
  1969. <dd class="phpdocumentor-argument-list__definition">
  1970. </dd>
  1971. </dl>
  1972. <section>
  1973. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1974. <span class="phpdocumentor-signature__response_type">self</span>
  1975. </section>
  1976. </article>
  1977. <article
  1978. class="phpdocumentor-element
  1979. -method
  1980. -public
  1981. "
  1982. >
  1983. <h4 class="phpdocumentor-element__name" id="method_setDarkModule">
  1984. setDarkModule()
  1985. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule" class="headerlink"><i class="fas fa-link"></i></a>
  1986. </h4>
  1987. <aside class="phpdocumentor-element-found-in">
  1988. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1989. :
  1990. <span class="phpdocumentor-element-found-in__line">397</span>
  1991. </aside>
  1992. <p class="phpdocumentor-summary">Sets the &quot;dark module&quot;, that is always on the same position 1x1px away from the bottom left finder</p>
  1993. <code class="phpdocumentor-code phpdocumentor-signature ">
  1994. <span class="phpdocumentor-signature__visibility">public</span>
  1995. <span class="phpdocumentor-signature__name">setDarkModule</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1996. <div class="phpdocumentor-label-line">
  1997. </div>
  1998. <section class="phpdocumentor-description"><p>4 * version + 9 or moduleCount - 8</p>
  1999. </section>
  2000. <section>
  2001. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2002. <span class="phpdocumentor-signature__response_type">self</span>
  2003. </section>
  2004. </article>
  2005. <article
  2006. class="phpdocumentor-element
  2007. -method
  2008. -public
  2009. "
  2010. >
  2011. <h4 class="phpdocumentor-element__name" id="method_setFinderPattern">
  2012. setFinderPattern()
  2013. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern" class="headerlink"><i class="fas fa-link"></i></a>
  2014. </h4>
  2015. <aside class="phpdocumentor-element-found-in">
  2016. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2017. :
  2018. <span class="phpdocumentor-element-found-in__line">408</span>
  2019. </aside>
  2020. <p class="phpdocumentor-summary">Draws the 7x7 finder patterns in the corners top left/right and bottom left</p>
  2021. <code class="phpdocumentor-code phpdocumentor-signature ">
  2022. <span class="phpdocumentor-signature__visibility">public</span>
  2023. <span class="phpdocumentor-signature__name">setFinderPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2024. <div class="phpdocumentor-label-line">
  2025. </div>
  2026. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.2</p>
  2027. </section>
  2028. <section>
  2029. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2030. <span class="phpdocumentor-signature__response_type">self</span>
  2031. </section>
  2032. </article>
  2033. <article
  2034. class="phpdocumentor-element
  2035. -method
  2036. -public
  2037. "
  2038. >
  2039. <h4 class="phpdocumentor-element__name" id="method_setFormatInfo">
  2040. setFormatInfo()
  2041. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo" class="headerlink"><i class="fas fa-link"></i></a>
  2042. </h4>
  2043. <aside class="phpdocumentor-element-found-in">
  2044. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2045. :
  2046. <span class="phpdocumentor-element-found-in__line">537</span>
  2047. </aside>
  2048. <p class="phpdocumentor-summary">Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false.</p>
  2049. <code class="phpdocumentor-code phpdocumentor-signature ">
  2050. <span class="phpdocumentor-signature__visibility">public</span>
  2051. <span class="phpdocumentor-signature__name">setFormatInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2052. <div class="phpdocumentor-label-line">
  2053. </div>
  2054. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.9</p>
  2055. </section>
  2056. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2057. <dl class="phpdocumentor-argument-list">
  2058. <dt class="phpdocumentor-argument-list__entry">
  2059. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  2060. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
  2061. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  2062. <dd class="phpdocumentor-argument-list__definition">
  2063. </dd>
  2064. </dl>
  2065. <section>
  2066. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2067. <span class="phpdocumentor-signature__response_type">self</span>
  2068. </section>
  2069. </article>
  2070. <article
  2071. class="phpdocumentor-element
  2072. -method
  2073. -public
  2074. "
  2075. >
  2076. <h4 class="phpdocumentor-element__name" id="method_setLogoSpace">
  2077. setLogoSpace()
  2078. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
  2079. </h4>
  2080. <aside class="phpdocumentor-element-found-in">
  2081. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2082. :
  2083. <span class="phpdocumentor-element-found-in__line">657</span>
  2084. </aside>
  2085. <p class="phpdocumentor-summary">Clears a space of $width * $height in order to add a logo or text.</p>
  2086. <code class="phpdocumentor-code phpdocumentor-signature ">
  2087. <span class="phpdocumentor-signature__visibility">public</span>
  2088. <span class="phpdocumentor-signature__name">setLogoSpace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$width</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startX</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startY</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2089. <div class="phpdocumentor-label-line">
  2090. </div>
  2091. <section class="phpdocumentor-description"><p>If no $height is given, the space will be assumed a square of $width.</p>
  2092. <p>Additionally, the logo space can be positioned within the QR Code using $startX and $startY.
  2093. If either of these are null, the logo space will be centered in that direction.
  2094. ECC level &quot;H&quot; (30%) is required.</p>
  2095. <p>The coordinates of $startX and $startY do not include the quiet zone:
  2096. [0, 0] is always the top left module of the top left finder pattern, negative values go into the quiet zone top and left.</p>
  2097. <p>Please note that adding a logo space minimizes the error correction capacity of the QR Code and
  2098. created images may become unreadable, especially when printed with a chance to receive damage.
  2099. Please test thoroughly before using this feature in production.</p>
  2100. <p>This method should be called from within an output module (after the matrix has been filled with data).
  2101. Note that there is no restiction on how many times this method could be called on the same matrix instance.</p>
  2102. </section>
  2103. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2104. <dl class="phpdocumentor-argument-list">
  2105. <dt class="phpdocumentor-argument-list__entry">
  2106. <span class="phpdocumentor-signature__argument__name">$width</span>
  2107. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2108. </dt>
  2109. <dd class="phpdocumentor-argument-list__definition">
  2110. </dd>
  2111. <dt class="phpdocumentor-argument-list__entry">
  2112. <span class="phpdocumentor-signature__argument__name">$height</span>
  2113. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2114. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  2115. <dd class="phpdocumentor-argument-list__definition">
  2116. </dd>
  2117. <dt class="phpdocumentor-argument-list__entry">
  2118. <span class="phpdocumentor-signature__argument__name">$startX</span>
  2119. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2120. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  2121. <dd class="phpdocumentor-argument-list__definition">
  2122. </dd>
  2123. <dt class="phpdocumentor-argument-list__entry">
  2124. <span class="phpdocumentor-signature__argument__name">$startY</span>
  2125. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2126. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  2127. <dd class="phpdocumentor-argument-list__definition">
  2128. </dd>
  2129. </dl>
  2130. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2131. Tags
  2132. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2133. </h5>
  2134. <dl class="phpdocumentor-tag-list">
  2135. <dt class="phpdocumentor-tag-list__entry">
  2136. <span class="phpdocumentor-tag__name">link</span>
  2137. </dt>
  2138. <dd class="phpdocumentor-tag-list__definition">
  2139. <a class="phpdocumentor-tag-link" href="https://github.com/chillerlan/php-qrcode/issues/52"> https://github.com/chillerlan/php-qrcode/issues/52 </a>
  2140. </dd>
  2141. <dt class="phpdocumentor-tag-list__entry">
  2142. <span class="phpdocumentor-tag__name">throws</span>
  2143. </dt>
  2144. <dd class="phpdocumentor-tag-list__definition">
  2145. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  2146. </dd>
  2147. </dl>
  2148. <section>
  2149. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2150. <span class="phpdocumentor-signature__response_type">self</span>
  2151. </section>
  2152. </article>
  2153. <article
  2154. class="phpdocumentor-element
  2155. -method
  2156. -public
  2157. "
  2158. >
  2159. <h4 class="phpdocumentor-element__name" id="method_setQuietZone">
  2160. setQuietZone()
  2161. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone" class="headerlink"><i class="fas fa-link"></i></a>
  2162. </h4>
  2163. <aside class="phpdocumentor-element-found-in">
  2164. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2165. :
  2166. <span class="phpdocumentor-element-found-in__line">579</span>
  2167. </aside>
  2168. <p class="phpdocumentor-summary">Draws the &quot;quiet zone&quot; of $size around the matrix</p>
  2169. <code class="phpdocumentor-code phpdocumentor-signature ">
  2170. <span class="phpdocumentor-signature__visibility">public</span>
  2171. <span class="phpdocumentor-signature__name">setQuietZone</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$quietZoneSize</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2172. <div class="phpdocumentor-label-line">
  2173. </div>
  2174. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.7</p>
  2175. </section>
  2176. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2177. <dl class="phpdocumentor-argument-list">
  2178. <dt class="phpdocumentor-argument-list__entry">
  2179. <span class="phpdocumentor-signature__argument__name">$quietZoneSize</span>
  2180. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2181. </dt>
  2182. <dd class="phpdocumentor-argument-list__definition">
  2183. </dd>
  2184. </dl>
  2185. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2186. Tags
  2187. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2188. </h5>
  2189. <dl class="phpdocumentor-tag-list">
  2190. <dt class="phpdocumentor-tag-list__entry">
  2191. <span class="phpdocumentor-tag__name">throws</span>
  2192. </dt>
  2193. <dd class="phpdocumentor-tag-list__definition">
  2194. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  2195. </dd>
  2196. </dl>
  2197. <section>
  2198. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2199. <span class="phpdocumentor-signature__response_type">self</span>
  2200. </section>
  2201. </article>
  2202. <article
  2203. class="phpdocumentor-element
  2204. -method
  2205. -public
  2206. "
  2207. >
  2208. <h4 class="phpdocumentor-element__name" id="method_setSeparators">
  2209. setSeparators()
  2210. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators" class="headerlink"><i class="fas fa-link"></i></a>
  2211. </h4>
  2212. <aside class="phpdocumentor-element-found-in">
  2213. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2214. :
  2215. <span class="phpdocumentor-element-found-in__line">432</span>
  2216. </aside>
  2217. <p class="phpdocumentor-summary">Draws the separator lines around the finder patterns</p>
  2218. <code class="phpdocumentor-code phpdocumentor-signature ">
  2219. <span class="phpdocumentor-signature__visibility">public</span>
  2220. <span class="phpdocumentor-signature__name">setSeparators</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2221. <div class="phpdocumentor-label-line">
  2222. </div>
  2223. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.3</p>
  2224. </section>
  2225. <section>
  2226. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2227. <span class="phpdocumentor-signature__response_type">self</span>
  2228. </section>
  2229. </article>
  2230. <article
  2231. class="phpdocumentor-element
  2232. -method
  2233. -public
  2234. "
  2235. >
  2236. <h4 class="phpdocumentor-element__name" id="method_setTimingPattern">
  2237. setTimingPattern()
  2238. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern" class="headerlink"><i class="fas fa-link"></i></a>
  2239. </h4>
  2240. <aside class="phpdocumentor-element-found-in">
  2241. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2242. :
  2243. <span class="phpdocumentor-element-found-in__line">491</span>
  2244. </aside>
  2245. <p class="phpdocumentor-summary">Draws the timing pattern (h/v checkered line between the finder patterns)</p>
  2246. <code class="phpdocumentor-code phpdocumentor-signature ">
  2247. <span class="phpdocumentor-signature__visibility">public</span>
  2248. <span class="phpdocumentor-signature__name">setTimingPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2249. <div class="phpdocumentor-label-line">
  2250. </div>
  2251. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.4</p>
  2252. </section>
  2253. <section>
  2254. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2255. <span class="phpdocumentor-signature__response_type">self</span>
  2256. </section>
  2257. </article>
  2258. <article
  2259. class="phpdocumentor-element
  2260. -method
  2261. -public
  2262. "
  2263. >
  2264. <h4 class="phpdocumentor-element__name" id="method_setVersionNumber">
  2265. setVersionNumber()
  2266. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber" class="headerlink"><i class="fas fa-link"></i></a>
  2267. </h4>
  2268. <aside class="phpdocumentor-element-found-in">
  2269. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2270. :
  2271. <span class="phpdocumentor-element-found-in__line">513</span>
  2272. </aside>
  2273. <p class="phpdocumentor-summary">Draws the version information, 2x 3x6 pixel</p>
  2274. <code class="phpdocumentor-code phpdocumentor-signature ">
  2275. <span class="phpdocumentor-signature__visibility">public</span>
  2276. <span class="phpdocumentor-signature__name">setVersionNumber</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2277. <div class="phpdocumentor-label-line">
  2278. </div>
  2279. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.10</p>
  2280. </section>
  2281. <section>
  2282. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2283. <span class="phpdocumentor-signature__response_type">self</span>
  2284. </section>
  2285. </article>
  2286. <article
  2287. class="phpdocumentor-element
  2288. -method
  2289. -public
  2290. -deprecated "
  2291. >
  2292. <h4 class="phpdocumentor-element__name" id="method_size">
  2293. size()
  2294. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size" class="headerlink"><i class="fas fa-link"></i></a>
  2295. </h4>
  2296. <aside class="phpdocumentor-element-found-in">
  2297. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2298. :
  2299. <span class="phpdocumentor-element-found-in__line">268</span>
  2300. </aside>
  2301. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2302. <span class="phpdocumentor-signature__visibility">public</span>
  2303. <span class="phpdocumentor-signature__name">size</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  2304. <div class="phpdocumentor-label-line">
  2305. </div>
  2306. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2307. Tags
  2308. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2309. </h5>
  2310. <dl class="phpdocumentor-tag-list">
  2311. <dt class="phpdocumentor-tag-list__entry">
  2312. <span class="phpdocumentor-tag__name">deprecated</span>
  2313. </dt>
  2314. <dd class="phpdocumentor-tag-list__definition">
  2315. <span class="phpdocumentor-tag-link">5.0.0</span>
  2316. <section class="phpdocumentor-description"><p>use QRMatrix::getSize() instead</p>
  2317. </section>
  2318. </dd>
  2319. <dt class="phpdocumentor-tag-list__entry">
  2320. <span class="phpdocumentor-tag__name">see</span>
  2321. </dt>
  2322. <dd class="phpdocumentor-tag-list__definition">
  2323. <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>
  2324. </dd>
  2325. <dt class="phpdocumentor-tag-list__entry">
  2326. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2327. </dt>
  2328. <dd class="phpdocumentor-tag-list__definition">
  2329. </dd>
  2330. </dl>
  2331. <section>
  2332. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2333. <span class="phpdocumentor-signature__response_type">int</span>
  2334. </section>
  2335. </article>
  2336. <article
  2337. class="phpdocumentor-element
  2338. -method
  2339. -public
  2340. -deprecated "
  2341. >
  2342. <h4 class="phpdocumentor-element__name" id="method_version">
  2343. version()
  2344. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version" class="headerlink"><i class="fas fa-link"></i></a>
  2345. </h4>
  2346. <aside class="phpdocumentor-element-found-in">
  2347. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2348. :
  2349. <span class="phpdocumentor-element-found-in__line">218</span>
  2350. </aside>
  2351. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2352. <span class="phpdocumentor-signature__visibility">public</span>
  2353. <span class="phpdocumentor-signature__name">version</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span></code>
  2354. <div class="phpdocumentor-label-line">
  2355. </div>
  2356. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2357. Tags
  2358. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2359. </h5>
  2360. <dl class="phpdocumentor-tag-list">
  2361. <dt class="phpdocumentor-tag-list__entry">
  2362. <span class="phpdocumentor-tag__name">deprecated</span>
  2363. </dt>
  2364. <dd class="phpdocumentor-tag-list__definition">
  2365. <span class="phpdocumentor-tag-link">5.0.0</span>
  2366. <section class="phpdocumentor-description"><p>use QRMatrix::getVersion() instead</p>
  2367. </section>
  2368. </dd>
  2369. <dt class="phpdocumentor-tag-list__entry">
  2370. <span class="phpdocumentor-tag__name">see</span>
  2371. </dt>
  2372. <dd class="phpdocumentor-tag-list__definition">
  2373. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getVersion()">QRMatrix::getVersion()</abbr></a></span>
  2374. </dd>
  2375. <dt class="phpdocumentor-tag-list__entry">
  2376. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2377. </dt>
  2378. <dd class="phpdocumentor-tag-list__definition">
  2379. </dd>
  2380. </dl>
  2381. <section>
  2382. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2383. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  2384. </section>
  2385. </article>
  2386. <article
  2387. class="phpdocumentor-element
  2388. -method
  2389. -public
  2390. "
  2391. >
  2392. <h4 class="phpdocumentor-element__name" id="method_writeCodewords">
  2393. writeCodewords()
  2394. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords" class="headerlink"><i class="fas fa-link"></i></a>
  2395. </h4>
  2396. <aside class="phpdocumentor-element-found-in">
  2397. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2398. :
  2399. <span class="phpdocumentor-element-found-in__line">720</span>
  2400. </aside>
  2401. <p class="phpdocumentor-summary">Maps the interleaved binary $data on the matrix</p>
  2402. <code class="phpdocumentor-code phpdocumentor-signature ">
  2403. <span class="phpdocumentor-signature__visibility">public</span>
  2404. <span class="phpdocumentor-signature__name">writeCodewords</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bitBuffer</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2405. <div class="phpdocumentor-label-line">
  2406. </div>
  2407. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2408. <dl class="phpdocumentor-argument-list">
  2409. <dt class="phpdocumentor-argument-list__entry">
  2410. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  2411. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  2412. </dt>
  2413. <dd class="phpdocumentor-argument-list__definition">
  2414. </dd>
  2415. </dl>
  2416. <section>
  2417. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2418. <span class="phpdocumentor-signature__response_type">self</span>
  2419. </section>
  2420. </article>
  2421. <article
  2422. class="phpdocumentor-element
  2423. -method
  2424. -protected
  2425. "
  2426. >
  2427. <h4 class="phpdocumentor-element__name" id="method_createMatrix">
  2428. createMatrix()
  2429. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  2430. </h4>
  2431. <aside class="phpdocumentor-element-found-in">
  2432. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2433. :
  2434. <span class="phpdocumentor-element-found-in__line">154</span>
  2435. </aside>
  2436. <p class="phpdocumentor-summary">Creates a 2-dimensional array (square) of the given $size</p>
  2437. <code class="phpdocumentor-code phpdocumentor-signature ">
  2438. <span class="phpdocumentor-signature__visibility">protected</span>
  2439. <span class="phpdocumentor-signature__name">createMatrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$size</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">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  2440. <div class="phpdocumentor-label-line">
  2441. </div>
  2442. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2443. <dl class="phpdocumentor-argument-list">
  2444. <dt class="phpdocumentor-argument-list__entry">
  2445. <span class="phpdocumentor-signature__argument__name">$size</span>
  2446. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2447. </dt>
  2448. <dd class="phpdocumentor-argument-list__definition">
  2449. </dd>
  2450. <dt class="phpdocumentor-argument-list__entry">
  2451. <span class="phpdocumentor-signature__argument__name">$value</span>
  2452. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2453. </dt>
  2454. <dd class="phpdocumentor-argument-list__definition">
  2455. </dd>
  2456. </dl>
  2457. <section>
  2458. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2459. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  2460. </section>
  2461. </article>
  2462. </section>
  2463. <div class="phpdocumentor-modal" id="source-view">
  2464. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  2465. <div class="phpdocumentor-modal-container">
  2466. <div class="phpdocumentor-modal-content">
  2467. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Data/QRMatrix.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  2468. </div>
  2469. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  2470. </div>
  2471. </div>
  2472. <script type="text/javascript">
  2473. (function () {
  2474. function loadExternalCodeSnippet(el, url, line) {
  2475. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  2476. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  2477. const language = 'php';
  2478. const code = document.createElement('code');
  2479. code.className = 'language-' + language;
  2480. pre.textContent = '';
  2481. pre.setAttribute('data-line', line)
  2482. code.textContent = 'Loading…';
  2483. pre.appendChild(code);
  2484. var xhr = new XMLHttpRequest();
  2485. xhr.open('GET', src, true);
  2486. xhr.onreadystatechange = function () {
  2487. if (xhr.readyState !== 4) {
  2488. return;
  2489. }
  2490. if (xhr.status < 400 && xhr.responseText) {
  2491. code.textContent = xhr.responseText;
  2492. Prism.highlightElement(code);
  2493. return;
  2494. }
  2495. if (xhr.status === 404) {
  2496. code.textContent = '✖ Error: File could not be found';
  2497. return;
  2498. }
  2499. if (xhr.status >= 400) {
  2500. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  2501. return;
  2502. }
  2503. code.textContent = '✖ Error: An unknown error occurred';
  2504. };
  2505. xhr.send(null);
  2506. });
  2507. }
  2508. const modalButtons = document.querySelectorAll("[data-modal]");
  2509. const openedAsLocalFile = window.location.protocol === 'file:';
  2510. if (modalButtons.length > 0 && openedAsLocalFile) {
  2511. console.warn(
  2512. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  2513. 'browsers block XHR requests when a page is opened this way'
  2514. );
  2515. }
  2516. modalButtons.forEach(function (trigger) {
  2517. if (openedAsLocalFile) {
  2518. trigger.setAttribute("hidden", "hidden");
  2519. }
  2520. trigger.addEventListener("click", function (event) {
  2521. event.preventDefault();
  2522. const modal = document.getElementById(trigger.dataset.modal);
  2523. if (!modal) {
  2524. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  2525. return;
  2526. }
  2527. modal.classList.add("phpdocumentor-modal__open");
  2528. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  2529. const exits = modal.querySelectorAll("[data-exit-button]");
  2530. exits.forEach(function (exit) {
  2531. exit.addEventListener("click", function (event) {
  2532. event.preventDefault();
  2533. modal.classList.remove("phpdocumentor-modal__open");
  2534. });
  2535. });
  2536. });
  2537. });
  2538. })();
  2539. </script>
  2540. </article>
  2541. </section>
  2542. <section class="phpdocumentor-on-this-page__sidebar">
  2543. <section class="phpdocumentor-on-this-page__content">
  2544. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  2545. <ul class="phpdocumentor-list -clean">
  2546. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  2547. <li>
  2548. <ul class="phpdocumentor-list -clean">
  2549. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#toc-constants">Constants</a></li>
  2550. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#toc-properties">Properties</a></li>
  2551. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#toc-methods">Methods</a></li>
  2552. </ul>
  2553. </li>
  2554. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  2555. <li>
  2556. <ul class="phpdocumentor-list -clean">
  2557. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK">IS_DARK</a></li>
  2558. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT">M_ALIGNMENT</a></li>
  2559. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK">M_ALIGNMENT_DARK</a></li>
  2560. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE">M_DARKMODULE</a></li>
  2561. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE_LIGHT">M_DARKMODULE_LIGHT</a></li>
  2562. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA">M_DATA</a></li>
  2563. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK">M_DATA_DARK</a></li>
  2564. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER">M_FINDER</a></li>
  2565. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK">M_FINDER_DARK</a></li>
  2566. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT">M_FINDER_DOT</a></li>
  2567. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT_LIGHT">M_FINDER_DOT_LIGHT</a></li>
  2568. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT">M_FORMAT</a></li>
  2569. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK">M_FORMAT_DARK</a></li>
  2570. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO">M_LOGO</a></li>
  2571. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO_DARK">M_LOGO_DARK</a></li>
  2572. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL">M_NULL</a></li>
  2573. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE">M_QUIETZONE</a></li>
  2574. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE_DARK">M_QUIETZONE_DARK</a></li>
  2575. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR">M_SEPARATOR</a></li>
  2576. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR_DARK">M_SEPARATOR_DARK</a></li>
  2577. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING">M_TIMING</a></li>
  2578. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK">M_TIMING_DARK</a></li>
  2579. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION">M_VERSION</a></li>
  2580. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK">M_VERSION_DARK</a></li>
  2581. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours">neighbours</a></li>
  2582. </ul>
  2583. </li>
  2584. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  2585. <li>
  2586. <ul class="phpdocumentor-list -clean">
  2587. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel">$eccLevel<a href="classes/chillerlan-QRCode-Data-QRMatrix.html"></li>
  2588. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern">$maskPattern<a href="classes/chillerlan-QRCode-Data-QRMatrix.html"></li>
  2589. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Data-QRMatrix.html"></li>
  2590. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Data-QRMatrix.html"></li>
  2591. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version">$version<a href="classes/chillerlan-QRCode-Data-QRMatrix.html"></li>
  2592. </ul>
  2593. </li>
  2594. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  2595. <li>
  2596. <ul class="phpdocumentor-list -clean">
  2597. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct">__construct()</a></li>
  2598. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check">check()</a></li>
  2599. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours">checkNeighbours()</a></li>
  2600. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType">checkType()</a></li>
  2601. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn">checkTypeIn()</a></li>
  2602. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel">eccLevel()</a></li>
  2603. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip">flip()</a></li>
  2604. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get">get()</a></li>
  2605. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel">getEccLevel()</a></li>
  2606. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern">getMaskPattern()</a></li>
  2607. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix">getMatrix()</a></li>
  2608. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize">getSize()</a></li>
  2609. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion">getVersion()</a></li>
  2610. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns">initFunctionalPatterns()</a></li>
  2611. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_invert">invert()</a></li>
  2612. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask">mask()</a></li>
  2613. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern">maskPattern()</a></li>
  2614. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix">matrix()</a></li>
  2615. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_rotate90">rotate90()</a></li>
  2616. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set">set()</a></li>
  2617. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern">setAlignmentPattern()</a></li>
  2618. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setArea">setArea()</a></li>
  2619. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule">setDarkModule()</a></li>
  2620. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern">setFinderPattern()</a></li>
  2621. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo">setFormatInfo()</a></li>
  2622. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace">setLogoSpace()</a></li>
  2623. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone">setQuietZone()</a></li>
  2624. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators">setSeparators()</a></li>
  2625. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern">setTimingPattern()</a></li>
  2626. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber">setVersionNumber()</a></li>
  2627. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size">size()</a></li>
  2628. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version">version()</a></li>
  2629. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords">writeCodewords()</a></li>
  2630. <li><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix">createMatrix()</a></li>
  2631. </ul>
  2632. </li>
  2633. </ul>
  2634. </section>
  2635. </section>
  2636. </div>
  2637. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  2638. <section class="phpdocumentor-search-results__dialog">
  2639. <header class="phpdocumentor-search-results__header">
  2640. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  2641. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  2642. </header>
  2643. <section class="phpdocumentor-search-results__body">
  2644. <ul class="phpdocumentor-search-results__entries"></ul>
  2645. </section>
  2646. </section>
  2647. </section>
  2648. </div>
  2649. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  2650. </main>
  2651. <script>
  2652. cssVars({});
  2653. </script>
  2654. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  2655. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  2656. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  2657. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  2658. </body>
  2659. </html>