chillerlan-QRCode-Decoder-BitMatrix.html 134 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897
  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=Source+Sans+Pro:wght@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/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-decoder.html">Decoder</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. BitMatrix
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">22</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">Holds a numerical representation of the final QR Code;
  109. maps the ECC coded binary data and applies the mask pattern</p>
  110. <h3 id="toc">
  111. Table of Contents
  112. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  113. </h3>
  114. <dl class="phpdocumentor-table-of-contents">
  115. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  116. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK">IS_DARK</a>
  117. <span>
  118. &nbsp;= 0b100000000000 </span>
  119. </dt>
  120. <dd></dd>
  121. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  122. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT">M_ALIGNMENT</a>
  123. <span>
  124. &nbsp;= 0b10000 </span>
  125. </dt>
  126. <dd></dd>
  127. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  128. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE">M_DARKMODULE</a>
  129. <span>
  130. &nbsp;= 0b1 </span>
  131. </dt>
  132. <dd></dd>
  133. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  134. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA">M_DATA</a>
  135. <span>
  136. &nbsp;= 0b10 </span>
  137. </dt>
  138. <dd></dd>
  139. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  140. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER">M_FINDER</a>
  141. <span>
  142. &nbsp;= 0b100 </span>
  143. </dt>
  144. <dd></dd>
  145. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  146. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT">M_FINDER_DOT</a>
  147. <span>
  148. &nbsp;= 0b10000000000 </span>
  149. </dt>
  150. <dd></dd>
  151. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  152. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT">M_FORMAT</a>
  153. <span>
  154. &nbsp;= 0b1000000 </span>
  155. </dt>
  156. <dd></dd>
  157. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  158. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO">M_LOGO</a>
  159. <span>
  160. &nbsp;= 0b1000000000 </span>
  161. </dt>
  162. <dd></dd>
  163. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  164. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL">M_NULL</a>
  165. <span>
  166. &nbsp;= 0b0 </span>
  167. </dt>
  168. <dd></dd>
  169. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  170. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE">M_QUIETZONE</a>
  171. <span>
  172. &nbsp;= 0b100000000 </span>
  173. </dt>
  174. <dd></dd>
  175. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  176. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR">M_SEPARATOR</a>
  177. <span>
  178. &nbsp;= 0b1000 </span>
  179. </dt>
  180. <dd></dd>
  181. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  182. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST">M_TEST</a>
  183. <span>
  184. &nbsp;= 0b11111111111 </span>
  185. </dt>
  186. <dd></dd>
  187. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  188. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING">M_TIMING</a>
  189. <span>
  190. &nbsp;= 0b100000 </span>
  191. </dt>
  192. <dd></dd>
  193. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  194. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION">M_VERSION</a>
  195. <span>
  196. &nbsp;= 0b10000000 </span>
  197. </dt>
  198. <dd></dd>
  199. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  200. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constant_DECODE_LOOKUP">DECODE_LOOKUP</a>
  201. <span>
  202. &nbsp;= [0x0 =&gt; 0x5412, 0x1 =&gt; 0x5125, 0x2 =&gt; 0x5e7c, 0x3 =&gt; 0x5b4b, 0x4 =&gt; 0x45f9, 0x5 =&gt; 0x40ce, 0x6 =&gt; 0x4f97, 0x7 =&gt; 0x4aa0, 0x8 =&gt; 0x77c4, 0x9 =&gt; 0x72f3, 0xa =&gt; 0x7daa, 0xb =&gt; 0x789d, 0xc =&gt; 0x662f, 0xd =&gt; 0x6318, 0xe =&gt; 0x6c41, 0xf =&gt; 0x6976, 0x10 =&gt; 0x1689, 0x11 =&gt; 0x13be, 0x12 =&gt; 0x1ce7, 0x13 =&gt; 0x19d0, 0x14 =&gt; 0x762, 0x15 =&gt; 0x255, 0x16 =&gt; 0xd0c, 0x17 =&gt; 0x83b, 0x18 =&gt; 0x355f, 0x19 =&gt; 0x3068, 0x1a =&gt; 0x3f31, 0x1b =&gt; 0x3a06, 0x1c =&gt; 0x24b4, 0x1d =&gt; 0x2183, 0x1e =&gt; 0x2eda, 0x1f =&gt; 0x2bed] </span>
  203. </dt>
  204. <dd>See ISO 18004:2006, Annex C, Table C.1</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  206. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constant_FORMAT_INFO_MASK_QR">FORMAT_INFO_MASK_QR</a>
  207. <span>
  208. &nbsp;= 0x5412 </span>
  209. </dt>
  210. <dd></dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  212. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel">$eccLevel</a>
  213. <span>
  214. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  215. </dt>
  216. <dd>the current ECC level</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  218. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern">$maskPattern</a>
  219. <span>
  220. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  221. </dt>
  222. <dd>the used mask pattern, set via QRMatrix::mask()</dd>
  223. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  224. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix">$matrix</a>
  225. <span>
  226. &nbsp;: array&lt;string|int, mixed&gt; </span>
  227. </dt>
  228. <dd>the actual matrix data array</dd>
  229. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  230. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount">$moduleCount</a>
  231. <span>
  232. &nbsp;: int </span>
  233. </dt>
  234. <dd>the size (side length) of the matrix, including quiet zone (if created)</dd>
  235. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  236. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version">$version</a>
  237. <span>
  238. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  239. </dt>
  240. <dd>a Version instance</dd>
  241. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  242. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_mirror">$mirror</a>
  243. <span>
  244. &nbsp;: bool </span>
  245. </dt>
  246. <dd></dd>
  247. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  248. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method___construct">__construct()</a>
  249. <span>
  250. &nbsp;: mixed </span>
  251. </dt>
  252. <dd>QRMatrix constructor.</dd>
  253. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  254. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check">check()</a>
  255. <span>
  256. &nbsp;: bool </span>
  257. </dt>
  258. <dd>Checks whether a module is true (dark) or false (light)</dd>
  259. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  260. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType">checkType()</a>
  261. <span>
  262. &nbsp;: bool </span>
  263. </dt>
  264. <dd>Checks whether a module is of the given $M_TYPE</dd>
  265. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  266. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypes">checkTypes()</a>
  267. <span>
  268. &nbsp;: bool </span>
  269. </dt>
  270. <dd>checks whether a module matches one of the given $M_TYPES</dd>
  271. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  272. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel">eccLevel()</a>
  273. <span>
  274. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  275. </dt>
  276. <dd>Returns the current ECC level</dd>
  277. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  278. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip">flip()</a>
  279. <span>
  280. &nbsp;: self </span>
  281. </dt>
  282. <dd>Flips the value of the module</dd>
  283. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  284. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get">get()</a>
  285. <span>
  286. &nbsp;: int </span>
  287. </dt>
  288. <dd>Returns the value of the module at position [$x, $y]</dd>
  289. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  290. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns">initFunctionalPatterns()</a>
  291. <span>
  292. &nbsp;: self </span>
  293. </dt>
  294. <dd>shortcut to initialize the functional patterns</dd>
  295. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  296. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask">mask()</a>
  297. <span>
  298. &nbsp;: self </span>
  299. </dt>
  300. <dd>Applies/reverses the mask pattern</dd>
  301. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  302. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern">maskPattern()</a>
  303. <span>
  304. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  305. </dt>
  306. <dd>Returns the current mask pattern</dd>
  307. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  308. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix">matrix()</a>
  309. <span>
  310. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt; </span>
  311. </dt>
  312. <dd>Returns the data matrix, returns a pure boolean representation if $boolean is set to true</dd>
  313. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  314. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_mirror">mirror()</a>
  315. <span>
  316. &nbsp;: self </span>
  317. </dt>
  318. <dd>Mirror the bit matrix in order to attempt a second reading.</dd>
  319. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  320. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readCodewords">readCodewords()</a>
  321. <span>
  322. &nbsp;: array&lt;string|int, mixed&gt; </span>
  323. </dt>
  324. <dd>Reads the bits in the BitMatrix representing the finder pattern in the
  325. correct order in order to reconstruct the codewords bytes contained within the
  326. QR Code.</dd>
  327. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  328. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set">set()</a>
  329. <span>
  330. &nbsp;: self </span>
  331. </dt>
  332. <dd>Sets the $M_TYPE value for the module at position [$x, $y]</dd>
  333. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  334. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern">setAlignmentPattern()</a>
  335. <span>
  336. &nbsp;: self </span>
  337. </dt>
  338. <dd>Draws the 5x5 alignment patterns</dd>
  339. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  340. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule">setDarkModule()</a>
  341. <span>
  342. &nbsp;: self </span>
  343. </dt>
  344. <dd>Sets the &quot;dark module&quot;, that is always on the same position 1x1px away from the bottom left finder</dd>
  345. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  346. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern">setFinderPattern()</a>
  347. <span>
  348. &nbsp;: self </span>
  349. </dt>
  350. <dd>Draws the 7x7 finder patterns in the corners top left/right and bottom left</dd>
  351. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  352. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo">setFormatInfo()</a>
  353. <span>
  354. &nbsp;: self </span>
  355. </dt>
  356. <dd>Draws the format info along the finder patterns</dd>
  357. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  358. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setLogoSpace">setLogoSpace()</a>
  359. <span>
  360. &nbsp;: self </span>
  361. </dt>
  362. <dd>Clears a space of $width * $height in order to add a logo or text.</dd>
  363. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  364. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setMirror">setMirror()</a>
  365. <span>
  366. &nbsp;: self </span>
  367. </dt>
  368. <dd>Prepare the parser for a mirrored operation.</dd>
  369. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  370. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setQuietZone">setQuietZone()</a>
  371. <span>
  372. &nbsp;: self </span>
  373. </dt>
  374. <dd>Draws the &quot;quiet zone&quot; of $size around the matrix</dd>
  375. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  376. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators">setSeparators()</a>
  377. <span>
  378. &nbsp;: self </span>
  379. </dt>
  380. <dd>Draws the separator lines around the finder patterns</dd>
  381. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  382. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern">setTimingPattern()</a>
  383. <span>
  384. &nbsp;: self </span>
  385. </dt>
  386. <dd>Draws the timing pattern (h/v checkered line between the finder patterns)</dd>
  387. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  388. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber">setVersionNumber()</a>
  389. <span>
  390. &nbsp;: self </span>
  391. </dt>
  392. <dd>Draws the version information, 2x 3x6 pixel</dd>
  393. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  394. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size">size()</a>
  395. <span>
  396. &nbsp;: int </span>
  397. </dt>
  398. <dd>Returns the absoulute size of the matrix, including quiet zone (after setting it).</dd>
  399. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  400. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version">version()</a>
  401. <span>
  402. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  403. </dt>
  404. <dd>Returns the current version number</dd>
  405. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  406. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords">writeCodewords()</a>
  407. <span>
  408. &nbsp;: self </span>
  409. </dt>
  410. <dd>Maps the interleaved binary $data on the matrix</dd>
  411. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  412. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_copyVersionBit">copyVersionBit()</a>
  413. <span>
  414. &nbsp;: int </span>
  415. </dt>
  416. <dd></dd>
  417. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  418. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_decodeVersionInformation">decodeVersionInformation()</a>
  419. <span>
  420. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  421. </dt>
  422. <dd></dd>
  423. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  424. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_doDecodeFormatInformation">doDecodeFormatInformation()</a>
  425. <span>
  426. &nbsp;: int|null </span>
  427. </dt>
  428. <dd></dd>
  429. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  430. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_numBitsDiffering">numBitsDiffering()</a>
  431. <span>
  432. &nbsp;: int </span>
  433. </dt>
  434. <dd></dd>
  435. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  436. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readFormatInformation">readFormatInformation()</a>
  437. <span>
  438. &nbsp;: self </span>
  439. </dt>
  440. <dd>Reads format information from one of its two locations within the QR Code.</dd>
  441. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  442. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readVersion">readVersion()</a>
  443. <span>
  444. &nbsp;: self </span>
  445. </dt>
  446. <dd>Reads version information from one of its two locations within the QR Code.</dd>
  447. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  448. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_uRShift">uRShift()</a>
  449. <span>
  450. &nbsp;: int </span>
  451. </dt>
  452. <dd></dd>
  453. </dl>
  454. <section class="phpdocumentor-constants">
  455. <h3 class="phpdocumentor-elements__header" id="constants">
  456. Constants
  457. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  458. </h3>
  459. <article class="phpdocumentor-element -constant -public ">
  460. <h4 class="phpdocumentor-element__name" id="constant_IS_DARK">
  461. IS_DARK
  462. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  463. </h4>
  464. <aside class="phpdocumentor-element-found-in">
  465. <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>
  466. :
  467. <span class="phpdocumentor-element-found-in__line">51</span>
  468. </aside>
  469. <code class="phpdocumentor-signature phpdocumentor-code ">
  470. <span class="phpdocumentor-signature__visibility">public</span>
  471. <span class="phpdocumentor-signature__type">int</span>
  472. <span class="phpdocumentor-signature__name">IS_DARK</span>
  473. = <span class="phpdocumentor-signature__default-value">0b100000000000</span>
  474. </code>
  475. </article>
  476. <article class="phpdocumentor-element -constant -public ">
  477. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT">
  478. M_ALIGNMENT
  479. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT" class="headerlink"><i class="fas fa-link"></i></a>
  480. </h4>
  481. <aside class="phpdocumentor-element-found-in">
  482. <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>
  483. :
  484. <span class="phpdocumentor-element-found-in__line">35</span>
  485. </aside>
  486. <code class="phpdocumentor-signature phpdocumentor-code ">
  487. <span class="phpdocumentor-signature__visibility">public</span>
  488. <span class="phpdocumentor-signature__type">int</span>
  489. <span class="phpdocumentor-signature__name">M_ALIGNMENT</span>
  490. = <span class="phpdocumentor-signature__default-value">0b10000</span>
  491. </code>
  492. </article>
  493. <article class="phpdocumentor-element -constant -public ">
  494. <h4 class="phpdocumentor-element__name" id="constant_M_DARKMODULE">
  495. M_DARKMODULE
  496. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE" class="headerlink"><i class="fas fa-link"></i></a>
  497. </h4>
  498. <aside class="phpdocumentor-element-found-in">
  499. <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>
  500. :
  501. <span class="phpdocumentor-element-found-in__line">27</span>
  502. </aside>
  503. <code class="phpdocumentor-signature phpdocumentor-code ">
  504. <span class="phpdocumentor-signature__visibility">public</span>
  505. <span class="phpdocumentor-signature__type">int</span>
  506. <span class="phpdocumentor-signature__name">M_DARKMODULE</span>
  507. = <span class="phpdocumentor-signature__default-value">0b1</span>
  508. </code>
  509. </article>
  510. <article class="phpdocumentor-element -constant -public ">
  511. <h4 class="phpdocumentor-element__name" id="constant_M_DATA">
  512. M_DATA
  513. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA" class="headerlink"><i class="fas fa-link"></i></a>
  514. </h4>
  515. <aside class="phpdocumentor-element-found-in">
  516. <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>
  517. :
  518. <span class="phpdocumentor-element-found-in__line">29</span>
  519. </aside>
  520. <code class="phpdocumentor-signature phpdocumentor-code ">
  521. <span class="phpdocumentor-signature__visibility">public</span>
  522. <span class="phpdocumentor-signature__type">int</span>
  523. <span class="phpdocumentor-signature__name">M_DATA</span>
  524. = <span class="phpdocumentor-signature__default-value">0b10</span>
  525. </code>
  526. </article>
  527. <article class="phpdocumentor-element -constant -public ">
  528. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER">
  529. M_FINDER
  530. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER" class="headerlink"><i class="fas fa-link"></i></a>
  531. </h4>
  532. <aside class="phpdocumentor-element-found-in">
  533. <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>
  534. :
  535. <span class="phpdocumentor-element-found-in__line">31</span>
  536. </aside>
  537. <code class="phpdocumentor-signature phpdocumentor-code ">
  538. <span class="phpdocumentor-signature__visibility">public</span>
  539. <span class="phpdocumentor-signature__type">int</span>
  540. <span class="phpdocumentor-signature__name">M_FINDER</span>
  541. = <span class="phpdocumentor-signature__default-value">0b100</span>
  542. </code>
  543. </article>
  544. <article class="phpdocumentor-element -constant -public ">
  545. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DOT">
  546. M_FINDER_DOT
  547. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT" class="headerlink"><i class="fas fa-link"></i></a>
  548. </h4>
  549. <aside class="phpdocumentor-element-found-in">
  550. <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>
  551. :
  552. <span class="phpdocumentor-element-found-in__line">47</span>
  553. </aside>
  554. <code class="phpdocumentor-signature phpdocumentor-code ">
  555. <span class="phpdocumentor-signature__visibility">public</span>
  556. <span class="phpdocumentor-signature__type">int</span>
  557. <span class="phpdocumentor-signature__name">M_FINDER_DOT</span>
  558. = <span class="phpdocumentor-signature__default-value">0b10000000000</span>
  559. </code>
  560. </article>
  561. <article class="phpdocumentor-element -constant -public ">
  562. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT">
  563. M_FORMAT
  564. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT" class="headerlink"><i class="fas fa-link"></i></a>
  565. </h4>
  566. <aside class="phpdocumentor-element-found-in">
  567. <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>
  568. :
  569. <span class="phpdocumentor-element-found-in__line">39</span>
  570. </aside>
  571. <code class="phpdocumentor-signature phpdocumentor-code ">
  572. <span class="phpdocumentor-signature__visibility">public</span>
  573. <span class="phpdocumentor-signature__type">int</span>
  574. <span class="phpdocumentor-signature__name">M_FORMAT</span>
  575. = <span class="phpdocumentor-signature__default-value">0b1000000</span>
  576. </code>
  577. </article>
  578. <article class="phpdocumentor-element -constant -public ">
  579. <h4 class="phpdocumentor-element__name" id="constant_M_LOGO">
  580. M_LOGO
  581. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO" class="headerlink"><i class="fas fa-link"></i></a>
  582. </h4>
  583. <aside class="phpdocumentor-element-found-in">
  584. <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>
  585. :
  586. <span class="phpdocumentor-element-found-in__line">45</span>
  587. </aside>
  588. <code class="phpdocumentor-signature phpdocumentor-code ">
  589. <span class="phpdocumentor-signature__visibility">public</span>
  590. <span class="phpdocumentor-signature__type">int</span>
  591. <span class="phpdocumentor-signature__name">M_LOGO</span>
  592. = <span class="phpdocumentor-signature__default-value">0b1000000000</span>
  593. </code>
  594. </article>
  595. <article class="phpdocumentor-element -constant -public ">
  596. <h4 class="phpdocumentor-element__name" id="constant_M_NULL">
  597. M_NULL
  598. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL" class="headerlink"><i class="fas fa-link"></i></a>
  599. </h4>
  600. <aside class="phpdocumentor-element-found-in">
  601. <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>
  602. :
  603. <span class="phpdocumentor-element-found-in__line">25</span>
  604. </aside>
  605. <code class="phpdocumentor-signature phpdocumentor-code ">
  606. <span class="phpdocumentor-signature__visibility">public</span>
  607. <span class="phpdocumentor-signature__type">int</span>
  608. <span class="phpdocumentor-signature__name">M_NULL</span>
  609. = <span class="phpdocumentor-signature__default-value">0b0</span>
  610. </code>
  611. </article>
  612. <article class="phpdocumentor-element -constant -public ">
  613. <h4 class="phpdocumentor-element__name" id="constant_M_QUIETZONE">
  614. M_QUIETZONE
  615. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE" class="headerlink"><i class="fas fa-link"></i></a>
  616. </h4>
  617. <aside class="phpdocumentor-element-found-in">
  618. <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>
  619. :
  620. <span class="phpdocumentor-element-found-in__line">43</span>
  621. </aside>
  622. <code class="phpdocumentor-signature phpdocumentor-code ">
  623. <span class="phpdocumentor-signature__visibility">public</span>
  624. <span class="phpdocumentor-signature__type">int</span>
  625. <span class="phpdocumentor-signature__name">M_QUIETZONE</span>
  626. = <span class="phpdocumentor-signature__default-value">0b100000000</span>
  627. </code>
  628. </article>
  629. <article class="phpdocumentor-element -constant -public ">
  630. <h4 class="phpdocumentor-element__name" id="constant_M_SEPARATOR">
  631. M_SEPARATOR
  632. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR" class="headerlink"><i class="fas fa-link"></i></a>
  633. </h4>
  634. <aside class="phpdocumentor-element-found-in">
  635. <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>
  636. :
  637. <span class="phpdocumentor-element-found-in__line">33</span>
  638. </aside>
  639. <code class="phpdocumentor-signature phpdocumentor-code ">
  640. <span class="phpdocumentor-signature__visibility">public</span>
  641. <span class="phpdocumentor-signature__type">int</span>
  642. <span class="phpdocumentor-signature__name">M_SEPARATOR</span>
  643. = <span class="phpdocumentor-signature__default-value">0b1000</span>
  644. </code>
  645. </article>
  646. <article class="phpdocumentor-element -constant -public ">
  647. <h4 class="phpdocumentor-element__name" id="constant_M_TEST">
  648. M_TEST
  649. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST" class="headerlink"><i class="fas fa-link"></i></a>
  650. </h4>
  651. <aside class="phpdocumentor-element-found-in">
  652. <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>
  653. :
  654. <span class="phpdocumentor-element-found-in__line">49</span>
  655. </aside>
  656. <code class="phpdocumentor-signature phpdocumentor-code ">
  657. <span class="phpdocumentor-signature__visibility">public</span>
  658. <span class="phpdocumentor-signature__type">int</span>
  659. <span class="phpdocumentor-signature__name">M_TEST</span>
  660. = <span class="phpdocumentor-signature__default-value">0b11111111111</span>
  661. </code>
  662. </article>
  663. <article class="phpdocumentor-element -constant -public ">
  664. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING">
  665. M_TIMING
  666. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING" class="headerlink"><i class="fas fa-link"></i></a>
  667. </h4>
  668. <aside class="phpdocumentor-element-found-in">
  669. <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>
  670. :
  671. <span class="phpdocumentor-element-found-in__line">37</span>
  672. </aside>
  673. <code class="phpdocumentor-signature phpdocumentor-code ">
  674. <span class="phpdocumentor-signature__visibility">public</span>
  675. <span class="phpdocumentor-signature__type">int</span>
  676. <span class="phpdocumentor-signature__name">M_TIMING</span>
  677. = <span class="phpdocumentor-signature__default-value">0b100000</span>
  678. </code>
  679. </article>
  680. <article class="phpdocumentor-element -constant -public ">
  681. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION">
  682. M_VERSION
  683. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION" class="headerlink"><i class="fas fa-link"></i></a>
  684. </h4>
  685. <aside class="phpdocumentor-element-found-in">
  686. <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>
  687. :
  688. <span class="phpdocumentor-element-found-in__line">41</span>
  689. </aside>
  690. <code class="phpdocumentor-signature phpdocumentor-code ">
  691. <span class="phpdocumentor-signature__visibility">public</span>
  692. <span class="phpdocumentor-signature__type">int</span>
  693. <span class="phpdocumentor-signature__name">M_VERSION</span>
  694. = <span class="phpdocumentor-signature__default-value">0b10000000</span>
  695. </code>
  696. </article>
  697. <article class="phpdocumentor-element -constant -private ">
  698. <h4 class="phpdocumentor-element__name" id="constant_DECODE_LOOKUP">
  699. DECODE_LOOKUP
  700. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constant_DECODE_LOOKUP" class="headerlink"><i class="fas fa-link"></i></a>
  701. </h4>
  702. <aside class="phpdocumentor-element-found-in">
  703. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  704. :
  705. <span class="phpdocumentor-element-found-in__line">29</span>
  706. </aside>
  707. <p class="phpdocumentor-summary">See ISO 18004:2006, Annex C, Table C.1</p>
  708. <code class="phpdocumentor-signature phpdocumentor-code ">
  709. <span class="phpdocumentor-signature__visibility">private</span>
  710. <span class="phpdocumentor-signature__type">mixed</span>
  711. <span class="phpdocumentor-signature__name">DECODE_LOOKUP</span>
  712. = <span class="phpdocumentor-signature__default-value">[0x0 =&gt; 0x5412, 0x1 =&gt; 0x5125, 0x2 =&gt; 0x5e7c, 0x3 =&gt; 0x5b4b, 0x4 =&gt; 0x45f9, 0x5 =&gt; 0x40ce, 0x6 =&gt; 0x4f97, 0x7 =&gt; 0x4aa0, 0x8 =&gt; 0x77c4, 0x9 =&gt; 0x72f3, 0xa =&gt; 0x7daa, 0xb =&gt; 0x789d, 0xc =&gt; 0x662f, 0xd =&gt; 0x6318, 0xe =&gt; 0x6c41, 0xf =&gt; 0x6976, 0x10 =&gt; 0x1689, 0x11 =&gt; 0x13be, 0x12 =&gt; 0x1ce7, 0x13 =&gt; 0x19d0, 0x14 =&gt; 0x762, 0x15 =&gt; 0x255, 0x16 =&gt; 0xd0c, 0x17 =&gt; 0x83b, 0x18 =&gt; 0x355f, 0x19 =&gt; 0x3068, 0x1a =&gt; 0x3f31, 0x1b =&gt; 0x3a06, 0x1c =&gt; 0x24b4, 0x1d =&gt; 0x2183, 0x1e =&gt; 0x2eda, 0x1f =&gt; 0x2bed]</span>
  713. </code>
  714. <section class="phpdocumentor-description"><p>[data bits, sequence after masking]</p>
  715. </section>
  716. <section class="phpdocumentor-description"></section>
  717. </article>
  718. <article class="phpdocumentor-element -constant -private ">
  719. <h4 class="phpdocumentor-element__name" id="constant_FORMAT_INFO_MASK_QR">
  720. FORMAT_INFO_MASK_QR
  721. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constant_FORMAT_INFO_MASK_QR" class="headerlink"><i class="fas fa-link"></i></a>
  722. </h4>
  723. <aside class="phpdocumentor-element-found-in">
  724. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  725. :
  726. <span class="phpdocumentor-element-found-in__line">64</span>
  727. </aside>
  728. <code class="phpdocumentor-signature phpdocumentor-code ">
  729. <span class="phpdocumentor-signature__visibility">private</span>
  730. <span class="phpdocumentor-signature__type">mixed</span>
  731. <span class="phpdocumentor-signature__name">FORMAT_INFO_MASK_QR</span>
  732. = <span class="phpdocumentor-signature__default-value">0x5412</span>
  733. </code>
  734. <section class="phpdocumentor-description"></section>
  735. <section class="phpdocumentor-description"></section>
  736. </article>
  737. </section>
  738. <section class="phpdocumentor-properties">
  739. <h3 class="phpdocumentor-elements__header" id="properties">
  740. Properties
  741. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  742. </h3>
  743. <article
  744. class="
  745. phpdocumentor-element
  746. -property
  747. -protected
  748. "
  749. >
  750. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  751. $eccLevel
  752. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  753. <span class="phpdocumentor-element__modifiers">
  754. </span>
  755. </h4>
  756. <aside class="phpdocumentor-element-found-in">
  757. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  758. :
  759. <span class="phpdocumentor-element-found-in__line">61</span>
  760. </aside>
  761. <p class="phpdocumentor-summary">the current ECC level</p>
  762. <code class="phpdocumentor-code phpdocumentor-signature ">
  763. <span class="phpdocumentor-signature__visibility">protected</span>
  764. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  765. <span class="phpdocumentor-signature__name">$eccLevel</span>
  766. = <span class="phpdocumentor-signature__default-value">null</span></code>
  767. <section class="phpdocumentor-description"></section>
  768. </article>
  769. <article
  770. class="
  771. phpdocumentor-element
  772. -property
  773. -protected
  774. "
  775. >
  776. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  777. $maskPattern
  778. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  779. <span class="phpdocumentor-element__modifiers">
  780. </span>
  781. </h4>
  782. <aside class="phpdocumentor-element-found-in">
  783. <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>
  784. :
  785. <span class="phpdocumentor-element-found-in__line">56</span>
  786. </aside>
  787. <p class="phpdocumentor-summary">the used mask pattern, set via QRMatrix::mask()</p>
  788. <code class="phpdocumentor-code phpdocumentor-signature ">
  789. <span class="phpdocumentor-signature__visibility">protected</span>
  790. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  791. <span class="phpdocumentor-signature__name">$maskPattern</span>
  792. = <span class="phpdocumentor-signature__default-value">null</span></code>
  793. <section class="phpdocumentor-description"></section>
  794. </article>
  795. <article
  796. class="
  797. phpdocumentor-element
  798. -property
  799. -protected
  800. "
  801. >
  802. <h4 class="phpdocumentor-element__name" id="property_matrix">
  803. $matrix
  804. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  805. <span class="phpdocumentor-element__modifiers">
  806. </span>
  807. </h4>
  808. <aside class="phpdocumentor-element-found-in">
  809. <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>
  810. :
  811. <span class="phpdocumentor-element-found-in__line">78</span>
  812. </aside>
  813. <p class="phpdocumentor-summary">the actual matrix data array</p>
  814. <code class="phpdocumentor-code phpdocumentor-signature ">
  815. <span class="phpdocumentor-signature__visibility">protected</span>
  816. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  817. <span class="phpdocumentor-signature__name">$matrix</span>
  818. </code>
  819. </article>
  820. <article
  821. class="
  822. phpdocumentor-element
  823. -property
  824. -protected
  825. "
  826. >
  827. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  828. $moduleCount
  829. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  830. <span class="phpdocumentor-element__modifiers">
  831. </span>
  832. </h4>
  833. <aside class="phpdocumentor-element-found-in">
  834. <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>
  835. :
  836. <span class="phpdocumentor-element-found-in__line">71</span>
  837. </aside>
  838. <p class="phpdocumentor-summary">the size (side length) of the matrix, including quiet zone (if created)</p>
  839. <code class="phpdocumentor-code phpdocumentor-signature ">
  840. <span class="phpdocumentor-signature__visibility">protected</span>
  841. <span class="phpdocumentor-signature__type">int</span>
  842. <span class="phpdocumentor-signature__name">$moduleCount</span>
  843. </code>
  844. <section class="phpdocumentor-description"></section>
  845. </article>
  846. <article
  847. class="
  848. phpdocumentor-element
  849. -property
  850. -protected
  851. "
  852. >
  853. <h4 class="phpdocumentor-element__name" id="property_version">
  854. $version
  855. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  856. <span class="phpdocumentor-element__modifiers">
  857. </span>
  858. </h4>
  859. <aside class="phpdocumentor-element-found-in">
  860. <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>
  861. :
  862. <span class="phpdocumentor-element-found-in__line">66</span>
  863. </aside>
  864. <p class="phpdocumentor-summary">a Version instance</p>
  865. <code class="phpdocumentor-code phpdocumentor-signature ">
  866. <span class="phpdocumentor-signature__visibility">protected</span>
  867. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  868. <span class="phpdocumentor-signature__name">$version</span>
  869. = <span class="phpdocumentor-signature__default-value">null</span></code>
  870. <section class="phpdocumentor-description"></section>
  871. </article>
  872. <article
  873. class="
  874. phpdocumentor-element
  875. -property
  876. -private
  877. "
  878. >
  879. <h4 class="phpdocumentor-element__name" id="property_mirror">
  880. $mirror
  881. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_mirror" class="headerlink"><i class="fas fa-link"></i></a>
  882. <span class="phpdocumentor-element__modifiers">
  883. </span>
  884. </h4>
  885. <aside class="phpdocumentor-element-found-in">
  886. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  887. :
  888. <span class="phpdocumentor-element-found-in__line">66</span>
  889. </aside>
  890. <code class="phpdocumentor-code phpdocumentor-signature ">
  891. <span class="phpdocumentor-signature__visibility">private</span>
  892. <span class="phpdocumentor-signature__type">bool</span>
  893. <span class="phpdocumentor-signature__name">$mirror</span>
  894. = <span class="phpdocumentor-signature__default-value">false</span></code>
  895. <section class="phpdocumentor-description"></section>
  896. <section class="phpdocumentor-description"></section>
  897. </article>
  898. </section>
  899. <section class="phpdocumentor-methods">
  900. <h3 class="phpdocumentor-elements__header" id="methods">
  901. Methods
  902. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  903. </h3>
  904. <article
  905. class="phpdocumentor-element
  906. -method
  907. -public
  908. "
  909. >
  910. <h4 class="phpdocumentor-element__name" id="method___construct">
  911. __construct()
  912. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  913. </h4>
  914. <aside class="phpdocumentor-element-found-in">
  915. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  916. :
  917. <span class="phpdocumentor-element-found-in__line">71</span>
  918. </aside>
  919. <p class="phpdocumentor-summary">QRMatrix constructor.</p>
  920. <code class="phpdocumentor-code phpdocumentor-signature ">
  921. <span class="phpdocumentor-signature__visibility">public</span>
  922. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$dimension</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  923. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  924. <dl class="phpdocumentor-argument-list">
  925. <dt class="phpdocumentor-argument-list__entry">
  926. <span class="phpdocumentor-signature__argument__name">$dimension</span>
  927. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  928. </dt>
  929. <dd class="phpdocumentor-argument-list__definition">
  930. <section class="phpdocumentor-description"></section>
  931. </dd>
  932. </dl>
  933. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  934. Tags
  935. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  936. </h5>
  937. <dl class="phpdocumentor-tag-list">
  938. <dt class="phpdocumentor-tag-list__entry">
  939. <span class="phpdocumentor-tag__name">noinspection</span>
  940. </dt>
  941. <dd class="phpdocumentor-tag-list__definition">
  942. <section class="phpdocumentor-description"><p>PhpMissingParentConstructorInspection</p>
  943. </section>
  944. </dd>
  945. </dl>
  946. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  947. <span class="phpdocumentor-signature__response_type">mixed</span>
  948. &mdash;
  949. </article>
  950. <article
  951. class="phpdocumentor-element
  952. -method
  953. -public
  954. "
  955. >
  956. <h4 class="phpdocumentor-element__name" id="method_check">
  957. check()
  958. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check" class="headerlink"><i class="fas fa-link"></i></a>
  959. </h4>
  960. <aside class="phpdocumentor-element-found-in">
  961. <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>
  962. :
  963. <span class="phpdocumentor-element-found-in__line">217</span>
  964. </aside>
  965. <p class="phpdocumentor-summary">Checks whether a module is true (dark) or false (light)</p>
  966. <code class="phpdocumentor-code phpdocumentor-signature ">
  967. <span class="phpdocumentor-signature__visibility">public</span>
  968. <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>
  969. <section class="phpdocumentor-description"><p>true =&gt; $value &amp; 0x800 === 0x800
  970. false =&gt; $value &amp; 0x800 === 0</p>
  971. </section>
  972. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  973. <dl class="phpdocumentor-argument-list">
  974. <dt class="phpdocumentor-argument-list__entry">
  975. <span class="phpdocumentor-signature__argument__name">$x</span>
  976. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  977. </dt>
  978. <dd class="phpdocumentor-argument-list__definition">
  979. <section class="phpdocumentor-description"></section>
  980. </dd>
  981. <dt class="phpdocumentor-argument-list__entry">
  982. <span class="phpdocumentor-signature__argument__name">$y</span>
  983. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  984. </dt>
  985. <dd class="phpdocumentor-argument-list__definition">
  986. <section class="phpdocumentor-description"></section>
  987. </dd>
  988. </dl>
  989. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  990. <span class="phpdocumentor-signature__response_type">bool</span>
  991. &mdash;
  992. </article>
  993. <article
  994. class="phpdocumentor-element
  995. -method
  996. -public
  997. "
  998. >
  999. <h4 class="phpdocumentor-element__name" id="method_checkType">
  1000. checkType()
  1001. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType" class="headerlink"><i class="fas fa-link"></i></a>
  1002. </h4>
  1003. <aside class="phpdocumentor-element-found-in">
  1004. <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>
  1005. :
  1006. <span class="phpdocumentor-element-found-in__line">193</span>
  1007. </aside>
  1008. <p class="phpdocumentor-summary">Checks whether a module is of the given $M_TYPE</p>
  1009. <code class="phpdocumentor-code phpdocumentor-signature ">
  1010. <span class="phpdocumentor-signature__visibility">public</span>
  1011. <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>
  1012. <section class="phpdocumentor-description"><p>true =&gt; $value &amp; $M_TYPE === $M_TYPE</p>
  1013. </section>
  1014. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1015. <dl class="phpdocumentor-argument-list">
  1016. <dt class="phpdocumentor-argument-list__entry">
  1017. <span class="phpdocumentor-signature__argument__name">$x</span>
  1018. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1019. </dt>
  1020. <dd class="phpdocumentor-argument-list__definition">
  1021. <section class="phpdocumentor-description"></section>
  1022. </dd>
  1023. <dt class="phpdocumentor-argument-list__entry">
  1024. <span class="phpdocumentor-signature__argument__name">$y</span>
  1025. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1026. </dt>
  1027. <dd class="phpdocumentor-argument-list__definition">
  1028. <section class="phpdocumentor-description"></section>
  1029. </dd>
  1030. <dt class="phpdocumentor-argument-list__entry">
  1031. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1032. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1033. </dt>
  1034. <dd class="phpdocumentor-argument-list__definition">
  1035. <section class="phpdocumentor-description"></section>
  1036. </dd>
  1037. </dl>
  1038. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1039. <span class="phpdocumentor-signature__response_type">bool</span>
  1040. &mdash;
  1041. </article>
  1042. <article
  1043. class="phpdocumentor-element
  1044. -method
  1045. -public
  1046. "
  1047. >
  1048. <h4 class="phpdocumentor-element__name" id="method_checkTypes">
  1049. checkTypes()
  1050. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypes" class="headerlink"><i class="fas fa-link"></i></a>
  1051. </h4>
  1052. <aside class="phpdocumentor-element-found-in">
  1053. <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>
  1054. :
  1055. <span class="phpdocumentor-element-found-in__line">200</span>
  1056. </aside>
  1057. <p class="phpdocumentor-summary">checks whether a module matches one of the given $M_TYPES</p>
  1058. <code class="phpdocumentor-code phpdocumentor-signature ">
  1059. <span class="phpdocumentor-signature__visibility">public</span>
  1060. <span class="phpdocumentor-signature__name">checkTypes</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>
  1061. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1062. <dl class="phpdocumentor-argument-list">
  1063. <dt class="phpdocumentor-argument-list__entry">
  1064. <span class="phpdocumentor-signature__argument__name">$x</span>
  1065. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1066. </dt>
  1067. <dd class="phpdocumentor-argument-list__definition">
  1068. <section class="phpdocumentor-description"></section>
  1069. </dd>
  1070. <dt class="phpdocumentor-argument-list__entry">
  1071. <span class="phpdocumentor-signature__argument__name">$y</span>
  1072. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1073. </dt>
  1074. <dd class="phpdocumentor-argument-list__definition">
  1075. <section class="phpdocumentor-description"></section>
  1076. </dd>
  1077. <dt class="phpdocumentor-argument-list__entry">
  1078. <span class="phpdocumentor-signature__argument__name">$M_TYPES</span>
  1079. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1080. </dt>
  1081. <dd class="phpdocumentor-argument-list__definition">
  1082. <section class="phpdocumentor-description"></section>
  1083. </dd>
  1084. </dl>
  1085. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1086. <span class="phpdocumentor-signature__response_type">bool</span>
  1087. &mdash;
  1088. </article>
  1089. <article
  1090. class="phpdocumentor-element
  1091. -method
  1092. -public
  1093. "
  1094. >
  1095. <h4 class="phpdocumentor-element__name" id="method_eccLevel">
  1096. eccLevel()
  1097. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1098. </h4>
  1099. <aside class="phpdocumentor-element-found-in">
  1100. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1101. :
  1102. <span class="phpdocumentor-element-found-in__line">140</span>
  1103. </aside>
  1104. <p class="phpdocumentor-summary">Returns the current ECC level</p>
  1105. <code class="phpdocumentor-code phpdocumentor-signature ">
  1106. <span class="phpdocumentor-signature__visibility">public</span>
  1107. <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>
  1108. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1109. <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>
  1110. &mdash;
  1111. </article>
  1112. <article
  1113. class="phpdocumentor-element
  1114. -method
  1115. -public
  1116. "
  1117. >
  1118. <h4 class="phpdocumentor-element__name" id="method_flip">
  1119. flip()
  1120. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip" class="headerlink"><i class="fas fa-link"></i></a>
  1121. </h4>
  1122. <aside class="phpdocumentor-element-found-in">
  1123. <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>
  1124. :
  1125. <span class="phpdocumentor-element-found-in__line">182</span>
  1126. </aside>
  1127. <p class="phpdocumentor-summary">Flips the value of the module</p>
  1128. <code class="phpdocumentor-code phpdocumentor-signature ">
  1129. <span class="phpdocumentor-signature__visibility">public</span>
  1130. <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>
  1131. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1132. <dl class="phpdocumentor-argument-list">
  1133. <dt class="phpdocumentor-argument-list__entry">
  1134. <span class="phpdocumentor-signature__argument__name">$x</span>
  1135. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1136. </dt>
  1137. <dd class="phpdocumentor-argument-list__definition">
  1138. <section class="phpdocumentor-description"></section>
  1139. </dd>
  1140. <dt class="phpdocumentor-argument-list__entry">
  1141. <span class="phpdocumentor-signature__argument__name">$y</span>
  1142. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1143. </dt>
  1144. <dd class="phpdocumentor-argument-list__definition">
  1145. <section class="phpdocumentor-description"></section>
  1146. </dd>
  1147. </dl>
  1148. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1149. <span class="phpdocumentor-signature__response_type">self</span>
  1150. &mdash;
  1151. </article>
  1152. <article
  1153. class="phpdocumentor-element
  1154. -method
  1155. -public
  1156. "
  1157. >
  1158. <h4 class="phpdocumentor-element__name" id="method_get">
  1159. get()
  1160. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
  1161. </h4>
  1162. <aside class="phpdocumentor-element-found-in">
  1163. <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>
  1164. :
  1165. <span class="phpdocumentor-element-found-in__line">163</span>
  1166. </aside>
  1167. <p class="phpdocumentor-summary">Returns the value of the module at position [$x, $y]</p>
  1168. <code class="phpdocumentor-code phpdocumentor-signature ">
  1169. <span class="phpdocumentor-signature__visibility">public</span>
  1170. <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>
  1171. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1172. <dl class="phpdocumentor-argument-list">
  1173. <dt class="phpdocumentor-argument-list__entry">
  1174. <span class="phpdocumentor-signature__argument__name">$x</span>
  1175. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1176. </dt>
  1177. <dd class="phpdocumentor-argument-list__definition">
  1178. <section class="phpdocumentor-description"></section>
  1179. </dd>
  1180. <dt class="phpdocumentor-argument-list__entry">
  1181. <span class="phpdocumentor-signature__argument__name">$y</span>
  1182. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1183. </dt>
  1184. <dd class="phpdocumentor-argument-list__definition">
  1185. <section class="phpdocumentor-description"></section>
  1186. </dd>
  1187. </dl>
  1188. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1189. <span class="phpdocumentor-signature__response_type">int</span>
  1190. &mdash;
  1191. </article>
  1192. <article
  1193. class="phpdocumentor-element
  1194. -method
  1195. -public
  1196. "
  1197. >
  1198. <h4 class="phpdocumentor-element__name" id="method_initFunctionalPatterns">
  1199. initFunctionalPatterns()
  1200. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns" class="headerlink"><i class="fas fa-link"></i></a>
  1201. </h4>
  1202. <aside class="phpdocumentor-element-found-in">
  1203. <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>
  1204. :
  1205. <span class="phpdocumentor-element-found-in__line">94</span>
  1206. </aside>
  1207. <p class="phpdocumentor-summary">shortcut to initialize the functional patterns</p>
  1208. <code class="phpdocumentor-code phpdocumentor-signature ">
  1209. <span class="phpdocumentor-signature__visibility">public</span>
  1210. <span class="phpdocumentor-signature__name">initFunctionalPatterns</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1211. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1212. <span class="phpdocumentor-signature__response_type">self</span>
  1213. &mdash;
  1214. </article>
  1215. <article
  1216. class="phpdocumentor-element
  1217. -method
  1218. -public
  1219. "
  1220. >
  1221. <h4 class="phpdocumentor-element__name" id="method_mask">
  1222. mask()
  1223. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask" class="headerlink"><i class="fas fa-link"></i></a>
  1224. </h4>
  1225. <aside class="phpdocumentor-element-found-in">
  1226. <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>
  1227. :
  1228. <span class="phpdocumentor-element-found-in__line">576</span>
  1229. </aside>
  1230. <p class="phpdocumentor-summary">Applies/reverses the mask pattern</p>
  1231. <code class="phpdocumentor-code phpdocumentor-signature ">
  1232. <span class="phpdocumentor-signature__visibility">public</span>
  1233. <span class="phpdocumentor-signature__name">mask</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1234. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.8.1</p>
  1235. </section>
  1236. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1237. <span class="phpdocumentor-signature__response_type">self</span>
  1238. &mdash;
  1239. </article>
  1240. <article
  1241. class="phpdocumentor-element
  1242. -method
  1243. -public
  1244. "
  1245. >
  1246. <h4 class="phpdocumentor-element__name" id="method_maskPattern">
  1247. maskPattern()
  1248. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1249. </h4>
  1250. <aside class="phpdocumentor-element-found-in">
  1251. <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>
  1252. :
  1253. <span class="phpdocumentor-element-found-in__line">147</span>
  1254. </aside>
  1255. <p class="phpdocumentor-summary">Returns the current mask pattern</p>
  1256. <code class="phpdocumentor-code phpdocumentor-signature ">
  1257. <span class="phpdocumentor-signature__visibility">public</span>
  1258. <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>
  1259. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1260. <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>
  1261. &mdash;
  1262. </article>
  1263. <article
  1264. class="phpdocumentor-element
  1265. -method
  1266. -public
  1267. "
  1268. >
  1269. <h4 class="phpdocumentor-element__name" id="method_matrix">
  1270. matrix()
  1271. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  1272. </h4>
  1273. <aside class="phpdocumentor-element-found-in">
  1274. <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>
  1275. :
  1276. <span class="phpdocumentor-element-found-in__line">111</span>
  1277. </aside>
  1278. <p class="phpdocumentor-summary">Returns the data matrix, returns a pure boolean representation if $boolean is set to true</p>
  1279. <code class="phpdocumentor-code phpdocumentor-signature ">
  1280. <span class="phpdocumentor-signature__visibility">public</span>
  1281. <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">false</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>
  1282. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1283. <dl class="phpdocumentor-argument-list">
  1284. <dt class="phpdocumentor-argument-list__entry">
  1285. <span class="phpdocumentor-signature__argument__name">$boolean</span>
  1286. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1287. = <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
  1288. <dd class="phpdocumentor-argument-list__definition">
  1289. <section class="phpdocumentor-description"></section>
  1290. </dd>
  1291. </dl>
  1292. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1293. <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>
  1294. &mdash;
  1295. </article>
  1296. <article
  1297. class="phpdocumentor-element
  1298. -method
  1299. -public
  1300. "
  1301. >
  1302. <h4 class="phpdocumentor-element__name" id="method_mirror">
  1303. mirror()
  1304. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_mirror" class="headerlink"><i class="fas fa-link"></i></a>
  1305. </h4>
  1306. <aside class="phpdocumentor-element-found-in">
  1307. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  1308. :
  1309. <span class="phpdocumentor-element-found-in__line">96</span>
  1310. </aside>
  1311. <p class="phpdocumentor-summary">Mirror the bit matrix in order to attempt a second reading.</p>
  1312. <code class="phpdocumentor-code phpdocumentor-signature ">
  1313. <span class="phpdocumentor-signature__visibility">public</span>
  1314. <span class="phpdocumentor-signature__name">mirror</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1315. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1316. <span class="phpdocumentor-signature__response_type">self</span>
  1317. &mdash;
  1318. </article>
  1319. <article
  1320. class="phpdocumentor-element
  1321. -method
  1322. -public
  1323. "
  1324. >
  1325. <h4 class="phpdocumentor-element__name" id="method_readCodewords">
  1326. readCodewords()
  1327. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readCodewords" class="headerlink"><i class="fas fa-link"></i></a>
  1328. </h4>
  1329. <aside class="phpdocumentor-element-found-in">
  1330. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  1331. :
  1332. <span class="phpdocumentor-element-found-in__line">118</span>
  1333. </aside>
  1334. <p class="phpdocumentor-summary">Reads the bits in the BitMatrix representing the finder pattern in the
  1335. correct order in order to reconstruct the codewords bytes contained within the
  1336. QR Code.</p>
  1337. <code class="phpdocumentor-code phpdocumentor-signature ">
  1338. <span class="phpdocumentor-signature__visibility">public</span>
  1339. <span class="phpdocumentor-signature__name">readCodewords</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1340. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1341. Tags
  1342. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1343. </h5>
  1344. <dl class="phpdocumentor-tag-list">
  1345. <dt class="phpdocumentor-tag-list__entry">
  1346. <span class="phpdocumentor-tag__name">throws</span>
  1347. </dt>
  1348. <dd class="phpdocumentor-tag-list__definition">
  1349. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  1350. <section class="phpdocumentor-description"><p>if the exact number of bytes expected is not read</p>
  1351. </section>
  1352. </dd>
  1353. </dl>
  1354. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1355. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1356. &mdash;
  1357. <section class="phpdocumentor-description"><p>bytes encoded within the QR Code</p>
  1358. </section>
  1359. </article>
  1360. <article
  1361. class="phpdocumentor-element
  1362. -method
  1363. -public
  1364. "
  1365. >
  1366. <h4 class="phpdocumentor-element__name" id="method_set">
  1367. set()
  1368. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
  1369. </h4>
  1370. <aside class="phpdocumentor-element-found-in">
  1371. <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>
  1372. :
  1373. <span class="phpdocumentor-element-found-in__line">173</span>
  1374. </aside>
  1375. <p class="phpdocumentor-summary">Sets the $M_TYPE value for the module at position [$x, $y]</p>
  1376. <code class="phpdocumentor-code phpdocumentor-signature ">
  1377. <span class="phpdocumentor-signature__visibility">public</span>
  1378. <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>
  1379. <section class="phpdocumentor-description"><p>true =&gt; $M_TYPE | 0x800
  1380. false =&gt; $M_TYPE</p>
  1381. </section>
  1382. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1383. <dl class="phpdocumentor-argument-list">
  1384. <dt class="phpdocumentor-argument-list__entry">
  1385. <span class="phpdocumentor-signature__argument__name">$x</span>
  1386. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1387. </dt>
  1388. <dd class="phpdocumentor-argument-list__definition">
  1389. <section class="phpdocumentor-description"></section>
  1390. </dd>
  1391. <dt class="phpdocumentor-argument-list__entry">
  1392. <span class="phpdocumentor-signature__argument__name">$y</span>
  1393. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1394. </dt>
  1395. <dd class="phpdocumentor-argument-list__definition">
  1396. <section class="phpdocumentor-description"></section>
  1397. </dd>
  1398. <dt class="phpdocumentor-argument-list__entry">
  1399. <span class="phpdocumentor-signature__argument__name">$value</span>
  1400. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1401. </dt>
  1402. <dd class="phpdocumentor-argument-list__definition">
  1403. <section class="phpdocumentor-description"></section>
  1404. </dd>
  1405. <dt class="phpdocumentor-argument-list__entry">
  1406. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1407. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1408. </dt>
  1409. <dd class="phpdocumentor-argument-list__definition">
  1410. <section class="phpdocumentor-description"></section>
  1411. </dd>
  1412. </dl>
  1413. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1414. <span class="phpdocumentor-signature__response_type">self</span>
  1415. &mdash;
  1416. </article>
  1417. <article
  1418. class="phpdocumentor-element
  1419. -method
  1420. -public
  1421. "
  1422. >
  1423. <h4 class="phpdocumentor-element__name" id="method_setAlignmentPattern">
  1424. setAlignmentPattern()
  1425. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1426. </h4>
  1427. <aside class="phpdocumentor-element-found-in">
  1428. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1429. :
  1430. <span class="phpdocumentor-element-found-in__line">302</span>
  1431. </aside>
  1432. <p class="phpdocumentor-summary">Draws the 5x5 alignment patterns</p>
  1433. <code class="phpdocumentor-code phpdocumentor-signature ">
  1434. <span class="phpdocumentor-signature__visibility">public</span>
  1435. <span class="phpdocumentor-signature__name">setAlignmentPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1436. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.5</p>
  1437. </section>
  1438. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1439. <span class="phpdocumentor-signature__response_type">self</span>
  1440. &mdash;
  1441. </article>
  1442. <article
  1443. class="phpdocumentor-element
  1444. -method
  1445. -public
  1446. "
  1447. >
  1448. <h4 class="phpdocumentor-element__name" id="method_setDarkModule">
  1449. setDarkModule()
  1450. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule" class="headerlink"><i class="fas fa-link"></i></a>
  1451. </h4>
  1452. <aside class="phpdocumentor-element-found-in">
  1453. <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>
  1454. :
  1455. <span class="phpdocumentor-element-found-in__line">226</span>
  1456. </aside>
  1457. <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>
  1458. <code class="phpdocumentor-code phpdocumentor-signature ">
  1459. <span class="phpdocumentor-signature__visibility">public</span>
  1460. <span class="phpdocumentor-signature__name">setDarkModule</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1461. <section class="phpdocumentor-description"><p>4 * version + 9 or moduleCount - 8</p>
  1462. </section>
  1463. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1464. <span class="phpdocumentor-signature__response_type">self</span>
  1465. &mdash;
  1466. </article>
  1467. <article
  1468. class="phpdocumentor-element
  1469. -method
  1470. -public
  1471. "
  1472. >
  1473. <h4 class="phpdocumentor-element__name" id="method_setFinderPattern">
  1474. setFinderPattern()
  1475. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern" 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">237</span>
  1481. </aside>
  1482. <p class="phpdocumentor-summary">Draws the 7x7 finder patterns in the corners top left/right and bottom left</p>
  1483. <code class="phpdocumentor-code phpdocumentor-signature ">
  1484. <span class="phpdocumentor-signature__visibility">public</span>
  1485. <span class="phpdocumentor-signature__name">setFinderPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1486. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.2</p>
  1487. </section>
  1488. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1489. <span class="phpdocumentor-signature__response_type">self</span>
  1490. &mdash;
  1491. </article>
  1492. <article
  1493. class="phpdocumentor-element
  1494. -method
  1495. -public
  1496. "
  1497. >
  1498. <h4 class="phpdocumentor-element__name" id="method_setFormatInfo">
  1499. setFormatInfo()
  1500. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo" class="headerlink"><i class="fas fa-link"></i></a>
  1501. </h4>
  1502. <aside class="phpdocumentor-element-found-in">
  1503. <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>
  1504. :
  1505. <span class="phpdocumentor-element-found-in__line">379</span>
  1506. </aside>
  1507. <p class="phpdocumentor-summary">Draws the format info along the finder patterns</p>
  1508. <code class="phpdocumentor-code phpdocumentor-signature ">
  1509. <span class="phpdocumentor-signature__visibility">public</span>
  1510. <span class="phpdocumentor-signature__name">setFormatInfo</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1511. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.9</p>
  1512. </section>
  1513. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1514. <span class="phpdocumentor-signature__response_type">self</span>
  1515. &mdash;
  1516. </article>
  1517. <article
  1518. class="phpdocumentor-element
  1519. -method
  1520. -public
  1521. "
  1522. >
  1523. <h4 class="phpdocumentor-element__name" id="method_setLogoSpace">
  1524. setLogoSpace()
  1525. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
  1526. </h4>
  1527. <aside class="phpdocumentor-element-found-in">
  1528. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  1529. :
  1530. <span class="phpdocumentor-element-found-in__line">432</span>
  1531. </aside>
  1532. <p class="phpdocumentor-summary">Clears a space of $width * $height in order to add a logo or text.</p>
  1533. <code class="phpdocumentor-code phpdocumentor-signature ">
  1534. <span class="phpdocumentor-signature__visibility">public</span>
  1535. <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 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>, </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>
  1536. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1537. <dl class="phpdocumentor-argument-list">
  1538. <dt class="phpdocumentor-argument-list__entry">
  1539. <span class="phpdocumentor-signature__argument__name">$width</span>
  1540. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1541. </dt>
  1542. <dd class="phpdocumentor-argument-list__definition">
  1543. <section class="phpdocumentor-description"></section>
  1544. </dd>
  1545. <dt class="phpdocumentor-argument-list__entry">
  1546. <span class="phpdocumentor-signature__argument__name">$height</span>
  1547. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1548. </dt>
  1549. <dd class="phpdocumentor-argument-list__definition">
  1550. <section class="phpdocumentor-description"></section>
  1551. </dd>
  1552. <dt class="phpdocumentor-argument-list__entry">
  1553. <span class="phpdocumentor-signature__argument__name">$startX</span>
  1554. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1555. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1556. <dd class="phpdocumentor-argument-list__definition">
  1557. <section class="phpdocumentor-description"></section>
  1558. </dd>
  1559. <dt class="phpdocumentor-argument-list__entry">
  1560. <span class="phpdocumentor-signature__argument__name">$startY</span>
  1561. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1562. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1563. <dd class="phpdocumentor-argument-list__definition">
  1564. <section class="phpdocumentor-description"></section>
  1565. </dd>
  1566. </dl>
  1567. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1568. Tags
  1569. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1570. </h5>
  1571. <dl class="phpdocumentor-tag-list">
  1572. <dt class="phpdocumentor-tag-list__entry">
  1573. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1574. </dt>
  1575. <dd class="phpdocumentor-tag-list__definition">
  1576. </dd>
  1577. <dt class="phpdocumentor-tag-list__entry">
  1578. <span class="phpdocumentor-tag__name">throws</span>
  1579. </dt>
  1580. <dd class="phpdocumentor-tag-list__definition">
  1581. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1582. </dd>
  1583. </dl>
  1584. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1585. <span class="phpdocumentor-signature__response_type">self</span>
  1586. &mdash;
  1587. </article>
  1588. <article
  1589. class="phpdocumentor-element
  1590. -method
  1591. -public
  1592. "
  1593. >
  1594. <h4 class="phpdocumentor-element__name" id="method_setMirror">
  1595. setMirror()
  1596. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setMirror" class="headerlink"><i class="fas fa-link"></i></a>
  1597. </h4>
  1598. <aside class="phpdocumentor-element-found-in">
  1599. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  1600. :
  1601. <span class="phpdocumentor-element-found-in__line">84</span>
  1602. </aside>
  1603. <p class="phpdocumentor-summary">Prepare the parser for a mirrored operation.</p>
  1604. <code class="phpdocumentor-code phpdocumentor-signature ">
  1605. <span class="phpdocumentor-signature__visibility">public</span>
  1606. <span class="phpdocumentor-signature__name">setMirror</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mirror</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1607. <section class="phpdocumentor-description"><p>This flag has effect only on the readFormatInformation() and the
  1608. readVersion() methods. Before proceeding with readCodewords() the
  1609. mirror() method should be called.</p>
  1610. </section>
  1611. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1612. <dl class="phpdocumentor-argument-list">
  1613. <dt class="phpdocumentor-argument-list__entry">
  1614. <span class="phpdocumentor-signature__argument__name">$mirror</span>
  1615. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1616. </dt>
  1617. <dd class="phpdocumentor-argument-list__definition">
  1618. <section class="phpdocumentor-description"><p>Whether to read version and format information mirrored.</p>
  1619. </section>
  1620. </dd>
  1621. </dl>
  1622. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1623. <span class="phpdocumentor-signature__response_type">self</span>
  1624. &mdash;
  1625. </article>
  1626. <article
  1627. class="phpdocumentor-element
  1628. -method
  1629. -public
  1630. "
  1631. >
  1632. <h4 class="phpdocumentor-element__name" id="method_setQuietZone">
  1633. setQuietZone()
  1634. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setQuietZone" class="headerlink"><i class="fas fa-link"></i></a>
  1635. </h4>
  1636. <aside class="phpdocumentor-element-found-in">
  1637. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  1638. :
  1639. <span class="phpdocumentor-element-found-in__line">424</span>
  1640. </aside>
  1641. <p class="phpdocumentor-summary">Draws the &quot;quiet zone&quot; of $size around the matrix</p>
  1642. <code class="phpdocumentor-code phpdocumentor-signature ">
  1643. <span class="phpdocumentor-signature__visibility">public</span>
  1644. <span class="phpdocumentor-signature__name">setQuietZone</span><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">$size</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>
  1645. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1646. <dl class="phpdocumentor-argument-list">
  1647. <dt class="phpdocumentor-argument-list__entry">
  1648. <span class="phpdocumentor-signature__argument__name">$size</span>
  1649. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1650. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1651. <dd class="phpdocumentor-argument-list__definition">
  1652. <section class="phpdocumentor-description"></section>
  1653. </dd>
  1654. </dl>
  1655. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1656. Tags
  1657. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1658. </h5>
  1659. <dl class="phpdocumentor-tag-list">
  1660. <dt class="phpdocumentor-tag-list__entry">
  1661. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1662. </dt>
  1663. <dd class="phpdocumentor-tag-list__definition">
  1664. </dd>
  1665. <dt class="phpdocumentor-tag-list__entry">
  1666. <span class="phpdocumentor-tag__name">throws</span>
  1667. </dt>
  1668. <dd class="phpdocumentor-tag-list__definition">
  1669. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1670. </dd>
  1671. </dl>
  1672. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1673. <span class="phpdocumentor-signature__response_type">self</span>
  1674. &mdash;
  1675. </article>
  1676. <article
  1677. class="phpdocumentor-element
  1678. -method
  1679. -public
  1680. "
  1681. >
  1682. <h4 class="phpdocumentor-element__name" id="method_setSeparators">
  1683. setSeparators()
  1684. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators" class="headerlink"><i class="fas fa-link"></i></a>
  1685. </h4>
  1686. <aside class="phpdocumentor-element-found-in">
  1687. <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>
  1688. :
  1689. <span class="phpdocumentor-element-found-in__line">272</span>
  1690. </aside>
  1691. <p class="phpdocumentor-summary">Draws the separator lines around the finder patterns</p>
  1692. <code class="phpdocumentor-code phpdocumentor-signature ">
  1693. <span class="phpdocumentor-signature__visibility">public</span>
  1694. <span class="phpdocumentor-signature__name">setSeparators</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1695. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.3</p>
  1696. </section>
  1697. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1698. <span class="phpdocumentor-signature__response_type">self</span>
  1699. &mdash;
  1700. </article>
  1701. <article
  1702. class="phpdocumentor-element
  1703. -method
  1704. -public
  1705. "
  1706. >
  1707. <h4 class="phpdocumentor-element__name" id="method_setTimingPattern">
  1708. setTimingPattern()
  1709. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1710. </h4>
  1711. <aside class="phpdocumentor-element-found-in">
  1712. <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>
  1713. :
  1714. <span class="phpdocumentor-element-found-in__line">333</span>
  1715. </aside>
  1716. <p class="phpdocumentor-summary">Draws the timing pattern (h/v checkered line between the finder patterns)</p>
  1717. <code class="phpdocumentor-code phpdocumentor-signature ">
  1718. <span class="phpdocumentor-signature__visibility">public</span>
  1719. <span class="phpdocumentor-signature__name">setTimingPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1720. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.4</p>
  1721. </section>
  1722. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1723. <span class="phpdocumentor-signature__response_type">self</span>
  1724. &mdash;
  1725. </article>
  1726. <article
  1727. class="phpdocumentor-element
  1728. -method
  1729. -public
  1730. "
  1731. >
  1732. <h4 class="phpdocumentor-element__name" id="method_setVersionNumber">
  1733. setVersionNumber()
  1734. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber" class="headerlink"><i class="fas fa-link"></i></a>
  1735. </h4>
  1736. <aside class="phpdocumentor-element-found-in">
  1737. <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>
  1738. :
  1739. <span class="phpdocumentor-element-found-in__line">355</span>
  1740. </aside>
  1741. <p class="phpdocumentor-summary">Draws the version information, 2x 3x6 pixel</p>
  1742. <code class="phpdocumentor-code phpdocumentor-signature ">
  1743. <span class="phpdocumentor-signature__visibility">public</span>
  1744. <span class="phpdocumentor-signature__name">setVersionNumber</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1745. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.10</p>
  1746. </section>
  1747. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1748. <span class="phpdocumentor-signature__response_type">self</span>
  1749. &mdash;
  1750. </article>
  1751. <article
  1752. class="phpdocumentor-element
  1753. -method
  1754. -public
  1755. "
  1756. >
  1757. <h4 class="phpdocumentor-element__name" id="method_size">
  1758. size()
  1759. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size" class="headerlink"><i class="fas fa-link"></i></a>
  1760. </h4>
  1761. <aside class="phpdocumentor-element-found-in">
  1762. <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>
  1763. :
  1764. <span class="phpdocumentor-element-found-in__line">156</span>
  1765. </aside>
  1766. <p class="phpdocumentor-summary">Returns the absoulute size of the matrix, including quiet zone (after setting it).</p>
  1767. <code class="phpdocumentor-code phpdocumentor-signature ">
  1768. <span class="phpdocumentor-signature__visibility">public</span>
  1769. <span class="phpdocumentor-signature__name">size</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1770. <section class="phpdocumentor-description"><p>size = version * 4 + 17 [ + 2 * quietzone size]</p>
  1771. </section>
  1772. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1773. <span class="phpdocumentor-signature__response_type">int</span>
  1774. &mdash;
  1775. </article>
  1776. <article
  1777. class="phpdocumentor-element
  1778. -method
  1779. -public
  1780. "
  1781. >
  1782. <h4 class="phpdocumentor-element__name" id="method_version">
  1783. version()
  1784. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version" class="headerlink"><i class="fas fa-link"></i></a>
  1785. </h4>
  1786. <aside class="phpdocumentor-element-found-in">
  1787. <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>
  1788. :
  1789. <span class="phpdocumentor-element-found-in__line">133</span>
  1790. </aside>
  1791. <p class="phpdocumentor-summary">Returns the current version number</p>
  1792. <code class="phpdocumentor-code phpdocumentor-signature ">
  1793. <span class="phpdocumentor-signature__visibility">public</span>
  1794. <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>
  1795. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1796. <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>
  1797. &mdash;
  1798. </article>
  1799. <article
  1800. class="phpdocumentor-element
  1801. -method
  1802. -public
  1803. "
  1804. >
  1805. <h4 class="phpdocumentor-element__name" id="method_writeCodewords">
  1806. writeCodewords()
  1807. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords" class="headerlink"><i class="fas fa-link"></i></a>
  1808. </h4>
  1809. <aside class="phpdocumentor-element-found-in">
  1810. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1811. :
  1812. <span class="phpdocumentor-element-found-in__line">529</span>
  1813. </aside>
  1814. <p class="phpdocumentor-summary">Maps the interleaved binary $data on the matrix</p>
  1815. <code class="phpdocumentor-code phpdocumentor-signature ">
  1816. <span class="phpdocumentor-signature__visibility">public</span>
  1817. <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>
  1818. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1819. <dl class="phpdocumentor-argument-list">
  1820. <dt class="phpdocumentor-argument-list__entry">
  1821. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  1822. : <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>
  1823. </dt>
  1824. <dd class="phpdocumentor-argument-list__definition">
  1825. <section class="phpdocumentor-description"></section>
  1826. </dd>
  1827. </dl>
  1828. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1829. <span class="phpdocumentor-signature__response_type">self</span>
  1830. &mdash;
  1831. </article>
  1832. <article
  1833. class="phpdocumentor-element
  1834. -method
  1835. -private
  1836. "
  1837. >
  1838. <h4 class="phpdocumentor-element__name" id="method_copyVersionBit">
  1839. copyVersionBit()
  1840. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_copyVersionBit" class="headerlink"><i class="fas fa-link"></i></a>
  1841. </h4>
  1842. <aside class="phpdocumentor-element-found-in">
  1843. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  1844. :
  1845. <span class="phpdocumentor-element-found-in__line">245</span>
  1846. </aside>
  1847. <code class="phpdocumentor-code phpdocumentor-signature ">
  1848. <span class="phpdocumentor-signature__visibility">private</span>
  1849. <span class="phpdocumentor-signature__name">copyVersionBit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$i</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">$j</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">$versionBits</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1850. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1851. <dl class="phpdocumentor-argument-list">
  1852. <dt class="phpdocumentor-argument-list__entry">
  1853. <span class="phpdocumentor-signature__argument__name">$i</span>
  1854. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1855. </dt>
  1856. <dd class="phpdocumentor-argument-list__definition">
  1857. <section class="phpdocumentor-description"></section>
  1858. </dd>
  1859. <dt class="phpdocumentor-argument-list__entry">
  1860. <span class="phpdocumentor-signature__argument__name">$j</span>
  1861. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1862. </dt>
  1863. <dd class="phpdocumentor-argument-list__definition">
  1864. <section class="phpdocumentor-description"></section>
  1865. </dd>
  1866. <dt class="phpdocumentor-argument-list__entry">
  1867. <span class="phpdocumentor-signature__argument__name">$versionBits</span>
  1868. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1869. </dt>
  1870. <dd class="phpdocumentor-argument-list__definition">
  1871. <section class="phpdocumentor-description"></section>
  1872. </dd>
  1873. </dl>
  1874. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1875. <span class="phpdocumentor-signature__response_type">int</span>
  1876. &mdash;
  1877. </article>
  1878. <article
  1879. class="phpdocumentor-element
  1880. -method
  1881. -private
  1882. "
  1883. >
  1884. <h4 class="phpdocumentor-element__name" id="method_decodeVersionInformation">
  1885. decodeVersionInformation()
  1886. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_decodeVersionInformation" class="headerlink"><i class="fas fa-link"></i></a>
  1887. </h4>
  1888. <aside class="phpdocumentor-element-found-in">
  1889. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  1890. :
  1891. <span class="phpdocumentor-element-found-in__line">357</span>
  1892. </aside>
  1893. <code class="phpdocumentor-code phpdocumentor-signature ">
  1894. <span class="phpdocumentor-signature__visibility">private</span>
  1895. <span class="phpdocumentor-signature__name">decodeVersionInformation</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$versionBits</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>
  1896. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1897. <dl class="phpdocumentor-argument-list">
  1898. <dt class="phpdocumentor-argument-list__entry">
  1899. <span class="phpdocumentor-signature__argument__name">$versionBits</span>
  1900. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1901. </dt>
  1902. <dd class="phpdocumentor-argument-list__definition">
  1903. <section class="phpdocumentor-description"></section>
  1904. </dd>
  1905. </dl>
  1906. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1907. <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>
  1908. &mdash;
  1909. </article>
  1910. <article
  1911. class="phpdocumentor-element
  1912. -method
  1913. -private
  1914. "
  1915. >
  1916. <h4 class="phpdocumentor-element__name" id="method_doDecodeFormatInformation">
  1917. doDecodeFormatInformation()
  1918. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_doDecodeFormatInformation" class="headerlink"><i class="fas fa-link"></i></a>
  1919. </h4>
  1920. <aside class="phpdocumentor-element-found-in">
  1921. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  1922. :
  1923. <span class="phpdocumentor-element-found-in__line">261</span>
  1924. </aside>
  1925. <code class="phpdocumentor-code phpdocumentor-signature ">
  1926. <span class="phpdocumentor-signature__visibility">private</span>
  1927. <span class="phpdocumentor-signature__name">doDecodeFormatInformation</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskedFormatInfo1</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">$maskedFormatInfo2</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</span></code>
  1928. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1929. <dl class="phpdocumentor-argument-list">
  1930. <dt class="phpdocumentor-argument-list__entry">
  1931. <span class="phpdocumentor-signature__argument__name">$maskedFormatInfo1</span>
  1932. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1933. </dt>
  1934. <dd class="phpdocumentor-argument-list__definition">
  1935. <section class="phpdocumentor-description"><p>format info indicator, with mask still applied</p>
  1936. </section>
  1937. </dd>
  1938. <dt class="phpdocumentor-argument-list__entry">
  1939. <span class="phpdocumentor-signature__argument__name">$maskedFormatInfo2</span>
  1940. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1941. </dt>
  1942. <dd class="phpdocumentor-argument-list__definition">
  1943. <section class="phpdocumentor-description"><p>second copy of same info; both are checked at the same time
  1944. to establish best match</p>
  1945. </section>
  1946. </dd>
  1947. </dl>
  1948. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1949. <span class="phpdocumentor-signature__response_type">int|null</span>
  1950. &mdash;
  1951. <section class="phpdocumentor-description"><p>information about the format it specifies, or null if doesn't seem to match any known pattern</p>
  1952. </section>
  1953. </article>
  1954. <article
  1955. class="phpdocumentor-element
  1956. -method
  1957. -private
  1958. "
  1959. >
  1960. <h4 class="phpdocumentor-element__name" id="method_numBitsDiffering">
  1961. numBitsDiffering()
  1962. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_numBitsDiffering" class="headerlink"><i class="fas fa-link"></i></a>
  1963. </h4>
  1964. <aside class="phpdocumentor-element-found-in">
  1965. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  1966. :
  1967. <span class="phpdocumentor-element-found-in__line">405</span>
  1968. </aside>
  1969. <code class="phpdocumentor-code phpdocumentor-signature ">
  1970. <span class="phpdocumentor-signature__visibility">private</span>
  1971. <span class="phpdocumentor-signature__name">numBitsDiffering</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$a</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">$b</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1972. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1973. <dl class="phpdocumentor-argument-list">
  1974. <dt class="phpdocumentor-argument-list__entry">
  1975. <span class="phpdocumentor-signature__argument__name">$a</span>
  1976. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1977. </dt>
  1978. <dd class="phpdocumentor-argument-list__definition">
  1979. <section class="phpdocumentor-description"></section>
  1980. </dd>
  1981. <dt class="phpdocumentor-argument-list__entry">
  1982. <span class="phpdocumentor-signature__argument__name">$b</span>
  1983. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1984. </dt>
  1985. <dd class="phpdocumentor-argument-list__definition">
  1986. <section class="phpdocumentor-description"></section>
  1987. </dd>
  1988. </dl>
  1989. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1990. <span class="phpdocumentor-signature__response_type">int</span>
  1991. &mdash;
  1992. </article>
  1993. <article
  1994. class="phpdocumentor-element
  1995. -method
  1996. -private
  1997. "
  1998. >
  1999. <h4 class="phpdocumentor-element__name" id="method_readFormatInformation">
  2000. readFormatInformation()
  2001. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readFormatInformation" class="headerlink"><i class="fas fa-link"></i></a>
  2002. </h4>
  2003. <aside class="phpdocumentor-element-found-in">
  2004. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  2005. :
  2006. <span class="phpdocumentor-element-found-in__line">184</span>
  2007. </aside>
  2008. <p class="phpdocumentor-summary">Reads format information from one of its two locations within the QR Code.</p>
  2009. <code class="phpdocumentor-code phpdocumentor-signature ">
  2010. <span class="phpdocumentor-signature__visibility">private</span>
  2011. <span class="phpdocumentor-signature__name">readFormatInformation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2012. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2013. Tags
  2014. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2015. </h5>
  2016. <dl class="phpdocumentor-tag-list">
  2017. <dt class="phpdocumentor-tag-list__entry">
  2018. <span class="phpdocumentor-tag__name">throws</span>
  2019. </dt>
  2020. <dd class="phpdocumentor-tag-list__definition">
  2021. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  2022. <section class="phpdocumentor-description"><p>if both format information locations cannot be parsed as
  2023. the valid encoding of format information</p>
  2024. </section>
  2025. </dd>
  2026. </dl>
  2027. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2028. <span class="phpdocumentor-signature__response_type">self</span>
  2029. &mdash;
  2030. </article>
  2031. <article
  2032. class="phpdocumentor-element
  2033. -method
  2034. -private
  2035. "
  2036. >
  2037. <h4 class="phpdocumentor-element__name" id="method_readVersion">
  2038. readVersion()
  2039. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readVersion" class="headerlink"><i class="fas fa-link"></i></a>
  2040. </h4>
  2041. <aside class="phpdocumentor-element-found-in">
  2042. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  2043. :
  2044. <span class="phpdocumentor-element-found-in__line">305</span>
  2045. </aside>
  2046. <p class="phpdocumentor-summary">Reads version information from one of its two locations within the QR Code.</p>
  2047. <code class="phpdocumentor-code phpdocumentor-signature ">
  2048. <span class="phpdocumentor-signature__visibility">private</span>
  2049. <span class="phpdocumentor-signature__name">readVersion</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2050. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2051. Tags
  2052. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2053. </h5>
  2054. <dl class="phpdocumentor-tag-list">
  2055. <dt class="phpdocumentor-tag-list__entry">
  2056. <span class="phpdocumentor-tag__name">throws</span>
  2057. </dt>
  2058. <dd class="phpdocumentor-tag-list__definition">
  2059. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  2060. <section class="phpdocumentor-description"><p>if both version information locations cannot be parsed as
  2061. the valid encoding of version information</p>
  2062. </section>
  2063. </dd>
  2064. <dt class="phpdocumentor-tag-list__entry">
  2065. <span class="phpdocumentor-tag__name">noinspection</span>
  2066. </dt>
  2067. <dd class="phpdocumentor-tag-list__definition">
  2068. <section class="phpdocumentor-description"><p>DuplicatedCode</p>
  2069. </section>
  2070. </dd>
  2071. </dl>
  2072. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2073. <span class="phpdocumentor-signature__response_type">self</span>
  2074. &mdash;
  2075. </article>
  2076. <article
  2077. class="phpdocumentor-element
  2078. -method
  2079. -private
  2080. "
  2081. >
  2082. <h4 class="phpdocumentor-element__name" id="method_uRShift">
  2083. uRShift()
  2084. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_uRShift" class="headerlink"><i class="fas fa-link"></i></a>
  2085. </h4>
  2086. <aside class="phpdocumentor-element-found-in">
  2087. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  2088. :
  2089. <span class="phpdocumentor-element-found-in__line">393</span>
  2090. </aside>
  2091. <code class="phpdocumentor-code phpdocumentor-signature ">
  2092. <span class="phpdocumentor-signature__visibility">private</span>
  2093. <span class="phpdocumentor-signature__name">uRShift</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$a</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">$b</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  2094. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2095. <dl class="phpdocumentor-argument-list">
  2096. <dt class="phpdocumentor-argument-list__entry">
  2097. <span class="phpdocumentor-signature__argument__name">$a</span>
  2098. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2099. </dt>
  2100. <dd class="phpdocumentor-argument-list__definition">
  2101. <section class="phpdocumentor-description"></section>
  2102. </dd>
  2103. <dt class="phpdocumentor-argument-list__entry">
  2104. <span class="phpdocumentor-signature__argument__name">$b</span>
  2105. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2106. </dt>
  2107. <dd class="phpdocumentor-argument-list__definition">
  2108. <section class="phpdocumentor-description"></section>
  2109. </dd>
  2110. </dl>
  2111. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2112. <span class="phpdocumentor-signature__response_type">int</span>
  2113. &mdash;
  2114. </article>
  2115. </section>
  2116. <script type="text/javascript">
  2117. function loadExternalCodeSnippets(line) {
  2118. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  2119. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  2120. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  2121. var language = 'php';
  2122. var code = document.createElement('code');
  2123. code.className = 'language-' + language;
  2124. pre.textContent = '';
  2125. pre.setAttribute('data-line', line)
  2126. code.textContent = 'Loading…';
  2127. pre.appendChild(code);
  2128. var xhr = new XMLHttpRequest();
  2129. xhr.open('GET', src, true);
  2130. xhr.onreadystatechange = function () {
  2131. if (xhr.readyState == 4) {
  2132. if (xhr.status < 400 && xhr.responseText) {
  2133. code.textContent = xhr.responseText;
  2134. Prism.highlightElement(code);
  2135. }
  2136. else if (xhr.status >= 400) {
  2137. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  2138. }
  2139. else {
  2140. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  2141. }
  2142. }
  2143. };
  2144. xhr.send(null);
  2145. });
  2146. }
  2147. var modals = document.querySelectorAll("[data-modal]");
  2148. modals.forEach(function (trigger) {
  2149. trigger.addEventListener("click", function (event) {
  2150. //event.preventDefault();
  2151. const modal = document.getElementById(trigger.dataset.modal);
  2152. modal.classList.add("phpdocumentor-modal__open");
  2153. loadExternalCodeSnippets(trigger.dataset.line)
  2154. const exits = modal.querySelectorAll("[data-exit-button]");
  2155. exits.forEach(function (exit) {
  2156. exit.addEventListener("click", function (event) {
  2157. event.preventDefault();
  2158. modal.classList.remove("phpdocumentor-modal__open");
  2159. });
  2160. });
  2161. });
  2162. });
  2163. </script>
  2164. </article>
  2165. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  2166. <section class="phpdocumentor-search-results__dialog">
  2167. <header class="phpdocumentor-search-results__header">
  2168. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  2169. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  2170. </header>
  2171. <section class="phpdocumentor-search-results__body">
  2172. <ul class="phpdocumentor-search-results__entries"></ul>
  2173. </section>
  2174. </section>
  2175. </section>
  2176. </div>
  2177. </div>
  2178. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  2179. </main>
  2180. <script>
  2181. cssVars({});
  2182. </script>
  2183. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  2184. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  2185. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  2186. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  2187. </body>
  2188. </html>