chillerlan-QRCode-Data-QRMatrix.html 170 KB

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