chillerlan-QRCode-Data-QRMatrix.html 173 KB

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