chillerlan-QRCode-Decoder-BitMatrix.html 134 KB

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