geckon01/php-qrcode
1
0
Fork 0
mirror of https://github.com/chillerlan/php-qrcode.git synced 2026-10-21 11:15:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

:octocat:

Browse Source
This commit is contained in:
smiley
2023-07-13 23:15:16 +02:00
parent ddd9ef0857
commit b0a2cb6f67
16 changed files with 295 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API-QRMatrix.md
+35 -28
View File
@@ -1,7 +1,8 @@
# `QRMatrix`
# QRMatrix
The full phpDocumentor API documentation can be found at [chillerlan.github.io/php-qrcode](https://chillerlan.github.io/php-qrcode/classes/chillerlan-QRCode-Data-QRMatrix.html).
## Methods
<!-- using non-breaking spaces chr(255) in the longest method signature to force the silly table to stretch -->
| method | return | description |
@@ -33,6 +34,7 @@ The full phpDocumentor API documentation can be found at [chillerlan.github.io/p
| `writeCodewords(BitBuffer $bitBuffer)` | `self` | Maps the interleaved binary data on the matrix |
| `mask(MaskPattern $maskPattern)` | `self` | Applies/reverses the mask pattern |
### Deprecated methods
| method | since | replacement |
@@ -43,33 +45,38 @@ The full phpDocumentor API documentation can be found at [chillerlan.github.io/p
| `maskPattern()` | `5.0.0` | `QRMatrix::getMaskPattern()` |
| `size()` | `5.0.0` | `QRMatrix::getSize()` |
## Constants
The `_DARK` prefixed constans exist purely for convenience - their value is the same as `QRMatrix::M_XXX\|QRMatrix::IS_DARK`, see [`QROutputInterface`](./API-QROutputInterface.md).
The `_DARK` and `_LIGHT` postfixed constans exist purely for convenience - their value is the same as
`QRMatrix::M_XXX | QRMatrix::IS_DARK` and `QRMatrix::M_XXX ^ QRMatrix::IS_DARK` respectively,
see [`QROutputInterface`](./API-QROutputInterface.md).
| name | description |
|--------------------|-----------------------------------------------------------------------------------|
| `IS_DARK` | sets the "dark" flag for the given value: `QRMatrix::M_DATA \| QRMatrix::IS_DARK` |
| `M_NULL` | module not set |
| `M_DARKMODULE` | once per matrix at `$xy = [8, 4 * $version + 9]` |
| `M_DATA` | the actual encoded data |
| `M_DATA_DARK` | convenience |
| `M_FINDER` | the 7x7 finder patterns |
| `M_FINDER_DARK` | convenience |
| `M_FINDER_DOT` | the inner 3x3 block of the finder pattern |
| `M_SEPARATOR` | separator lines along the finder patterns |
| `M_SEPARATOR_DARK` | convenience |
| `M_ALIGNMENT` | the 5x5 alignment patterns |
| `M_ALIGNMENT_DARK` | convenience |
| `M_TIMING` | the timing pattern lines |
| `M_TIMING_DARK` | convenience |
| `M_FORMAT` | format information pattern |
| `M_FORMAT_DARK` | convenience |
| `M_VERSION` | version information pattern |
| `M_VERSION_DARK` | convenience |
| `M_QUIETZONE` | margin around the QR Code |
| `M_QUIETZONE_DARK` | convenience |
| `M_LOGO` | space for a logo image (not used yet) |
| `M_LOGO_DARK` | convenience |
| `M_TEST` | test value |
| `M_TEST_DARK` | convenience |
| name | description |
|----------------------|-----------------------------------------------------------------------------------|
| `IS_DARK` | sets the "dark" flag for the given value: `QRMatrix::M_DATA \| QRMatrix::IS_DARK` |
| `M_NULL` | module not set |
| `M_DARKMODULE_LIGHT` | convenience (reversed reflectance) |
| `M_DARKMODULE` | once per matrix at `$xy = [8, 4 * $version + 9]` |
| `M_DATA` | the actual encoded data |
| `M_DATA_DARK` | convenience |
| `M_FINDER` | the 7x7 finder patterns |
| `M_FINDER_DARK` | convenience |
| `M_FINDER_DOT_LIGHT` | convenience (reversed reflectance) |
| `M_FINDER_DOT` | the inner 3x3 block of the finder pattern |
| `M_SEPARATOR` | separator lines along the finder patterns |
| `M_SEPARATOR_DARK` | convenience |
| `M_ALIGNMENT` | the 5x5 alignment patterns |
| `M_ALIGNMENT_DARK` | convenience |
| `M_TIMING` | the timing pattern lines |
| `M_TIMING_DARK` | convenience |
| `M_FORMAT` | format information pattern |
| `M_FORMAT_DARK` | convenience |
| `M_VERSION` | version information pattern |
| `M_VERSION_DARK` | convenience |
| `M_QUIETZONE` | margin around the QR Code |
| `M_QUIETZONE_DARK` | convenience |
| `M_LOGO` | space for a logo image (not used yet) |
| `M_LOGO_DARK` | convenience |
| `M_TEST` | test value |
| `M_TEST_DARK` | convenience |