Skip to content

Commit b0a2cb6

Browse files
codemashercodemasher
committed
:octocat:
1 parent ddd9ef0 commit b0a2cb6

16 files changed

+295
-48
lines changed

‎docs/API-DecoderResult.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# `DecoderResult`
1+
# DecoderResult
22

33
The full phpDocumentor API documentation can be found at [chillerlan.github.io/php-qrcode](https://chillerlan.github.io/php-qrcode/classes/chillerlan-QRCode-Decoder-DecoderResult.html).
44

5+
56
## Methods
67

78
| method | return | description |
@@ -11,6 +12,7 @@ The full phpDocumentor API documentation can be found at [chillerlan.github.io/p
1112
| `hasStructuredAppend()` | `bool` | |
1213
| `getQRMatrix()` | `QRMatrix` | |
1314

15+
1416
## Magic Properties (read-only)
1517

1618
| property | type | description |

‎docs/API-QRCode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `QRCode`
1+
# QRCode
22

33
The full phpDocumentor API documentation can be found at [chillerlan.github.io/php-qrcode](https://chillerlan.github.io/php-qrcode/classes/chillerlan-QRCode-QRCode.html).
44

‎docs/API-QRMatrix.md

Lines changed: 35 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# `QRMatrix`
1+
# QRMatrix
22

33
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).
44

5+
56
## Methods
67
<!-- using non-breaking spaces chr(255) in the longest method signature to force the silly table to stretch -->
78
| method | return | description |
@@ -33,6 +34,7 @@ The full phpDocumentor API documentation can be found at [chillerlan.github.io/p
3334
| `writeCodewords(BitBuffer $bitBuffer)` | `self` | Maps the interleaved binary data on the matrix |
3435
| `mask(MaskPattern $maskPattern)` | `self` | Applies/reverses the mask pattern |
3536

37+
3638
### Deprecated methods
3739

3840
| method | since | replacement |
@@ -43,33 +45,38 @@ The full phpDocumentor API documentation can be found at [chillerlan.github.io/p
4345
| `maskPattern()` | `5.0.0` | `QRMatrix::getMaskPattern()` |
4446
| `size()` | `5.0.0` | `QRMatrix::getSize()` |
4547

48+
4649
## Constants
4750

48-
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).
51+
The `_DARK` and `_LIGHT` postfixed constans exist purely for convenience - their value is the same as
52+
`QRMatrix::M_XXX | QRMatrix::IS_DARK` and `QRMatrix::M_XXX ^ QRMatrix::IS_DARK` respectively,
53+
see [`QROutputInterface`](./API-QROutputInterface.md).
4954

50-
| name | description |
51-
|--------------------|-----------------------------------------------------------------------------------|
52-
| `IS_DARK` | sets the "dark" flag for the given value: `QRMatrix::M_DATA \| QRMatrix::IS_DARK` |
53-
| `M_NULL` | module not set |
54-
| `M_DARKMODULE` | once per matrix at `$xy = [8, 4 * $version + 9]` |
55-
| `M_DATA` | the actual encoded data |
56-
| `M_DATA_DARK` | convenience |
57-
| `M_FINDER` | the 7x7 finder patterns |
58-
| `M_FINDER_DARK` | convenience |
59-
| `M_FINDER_DOT` | the inner 3x3 block of the finder pattern |
60-
| `M_SEPARATOR` | separator lines along the finder patterns |
61-
| `M_SEPARATOR_DARK` | convenience |
62-
| `M_ALIGNMENT` | the 5x5 alignment patterns |
63-
| `M_ALIGNMENT_DARK` | convenience |
64-
| `M_TIMING` | the timing pattern lines |
65-
| `M_TIMING_DARK` | convenience |
66-
| `M_FORMAT` | format information pattern |
67-
| `M_FORMAT_DARK` | convenience |
68-
| `M_VERSION` | version information pattern |
69-
| `M_VERSION_DARK` | convenience |
70-
| `M_QUIETZONE` | margin around the QR Code |
71-
| `M_QUIETZONE_DARK` | convenience |
72-
| `M_LOGO` | space for a logo image (not used yet) |
73-
| `M_LOGO_DARK` | convenience |
74-
| `M_TEST` | test value |
75-
| `M_TEST_DARK` | convenience |
55+
| name | description |
56+
|----------------------|-----------------------------------------------------------------------------------|
57+
| `IS_DARK` | sets the "dark" flag for the given value: `QRMatrix::M_DATA \| QRMatrix::IS_DARK` |
58+
| `M_NULL` | module not set |
59+
| `M_DARKMODULE_LIGHT` | convenience (reversed reflectance) |
60+
| `M_DARKMODULE` | once per matrix at `$xy = [8, 4 * $version + 9]` |
61+
| `M_DATA` | the actual encoded data |
62+
| `M_DATA_DARK` | convenience |
63+
| `M_FINDER` | the 7x7 finder patterns |
64+
| `M_FINDER_DARK` | convenience |
65+
| `M_FINDER_DOT_LIGHT` | convenience (reversed reflectance) |
66+
| `M_FINDER_DOT` | the inner 3x3 block of the finder pattern |
67+
| `M_SEPARATOR` | separator lines along the finder patterns |
68+
| `M_SEPARATOR_DARK` | convenience |
69+
| `M_ALIGNMENT` | the 5x5 alignment patterns |
70+
| `M_ALIGNMENT_DARK` | convenience |
71+
| `M_TIMING` | the timing pattern lines |
72+
| `M_TIMING_DARK` | convenience |
73+
| `M_FORMAT` | format information pattern |
74+
| `M_FORMAT_DARK` | convenience |
75+
| `M_VERSION` | version information pattern |
76+
| `M_VERSION_DARK` | convenience |
77+
| `M_QUIETZONE` | margin around the QR Code |
78+
| `M_QUIETZONE_DARK` | convenience |
79+
| `M_LOGO` | space for a logo image (not used yet) |
80+
| `M_LOGO_DARK` | convenience |
81+
| `M_TEST` | test value |
82+
| `M_TEST_DARK` | convenience |

‎docs/API-QROptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `QROptions`
1+
# QROptions
22
(via `QROptionsTrait`)
33

44
The full phpDocumentor API documentation can be found at [chillerlan.github.io/php-qrcode](https://chillerlan.github.io/php-qrcode/classes/chillerlan-QRCode-QROptions.html).

‎docs/API-QROutputInterface.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# `QROutputInterface`
1+
# QROutputInterface
22

33
The full phpDocumentor API documentation can be found at [chillerlan.github.io/php-qrcode](https://chillerlan.github.io/php-qrcode/classes/chillerlan-QRCode-Output-QROutputInterface.html).
44

5-
## Methods
65

6+
## Methods
7+
<!-- using non-breaking spaces chr(255) in the longest method signature to force the silly table to stretch -->
78
| method | return | description |
89
|---------------------------------------|---------|---------------------------------------------------------------------|
910
| (static) `moduleValueIsValid($value)` | `bool` | Determines whether the given value is valid |
1011
| `dump(string $file = null)` | `mixed` | Generates the output, optionally dumps it to a file, and returns it |
1112

13+
1214
## Constants
1315

1416
| name | description |

‎docs/Appendix-Glossary.md renamed to ‎docs/Appendix-Terminology.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ alternate character encoding for the following Byte segment (by default, ISO-885
206206
An ECI segment starts with the 4 bit indicator `0111` followed by the ECI Assignment number (8, 16 or 24 bits),
207207
followed by a Byte segment (`0100` ...) where the contents are encoded according to the preceding ECI ID.
208208

209-
The lenght of the ECI Assignment number depends on the given encoding ID:
209+
The length of the ECI Assignment number depends on the given encoding ID:
210210

211211
| ID | length (bits) |
212212
|----------------|---------------|

‎docs/Built-In-Output-QREps.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# QREps
2+
3+
[Class `QREps`](https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QREps.php): [Encapsulated Postscript](https://en.wikipedia.org/wiki/Encapsulated_PostScript) (EPS) output
4+
5+
6+
## Options that affect this module
7+
8+
| property | type |
9+
|--------------------------------|----------------|
10+
| `$drawLightModules` | `bool` |
11+
| `$connectPaths` | `bool` |
12+
| `$excludeFromConnect` | `array` |
13+
| `$scale` | `int` |
14+
15+
16+
### Options that have no effect
17+
18+
| property | reason |
19+
|------------------------|-----------------|
20+
| `$returnResource` | N/A |
21+
| `$imageBase64` | N/A |
22+
| `$bgColor` | not implemented |
23+
| `$drawCircularModules` | not implemented |
24+
| `$circleRadius` | not implemented |
25+
| `$keepAsSquare` | not implemented |
26+
| `$imageTransparent` | N/A |

‎docs/Built-In-Output-QRFpdf.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# QRFpdf
2+
3+
[Class `QRFpdf`](https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QRFpdf.php): [Portable Document Format](https://en.wikipedia.org/wiki/PDF) (PDF) output via [FPDF](https://github.com/setasign/fpdf)
4+
5+
6+
## Options that affect this module
7+
8+
| property | type |
9+
|--------------------------------|----------------|
10+
| `$returnResource` | `bool` |
11+
| `$imageBase64` | `bool` |
12+
| `$bgColor` | `mixed` |
13+
| `$drawLightModules` | `bool` |
14+
| `$fpdfMeasureUnit` | `string` |
15+
16+
17+
### Options that have no effect
18+
19+
| property | reason |
20+
|------------------------|-----------------|
21+
| `$drawCircularModules` | N/A |
22+
| `$circleRadius` | N/A |
23+
| `$keepAsSquare` | N/A |
24+
| `$connectPaths` | N/A |
25+
| `$excludeFromConnect` | N/A |
26+
| `$scale` | not implemented |
27+
| `$imageTransparent` | N/A |
28+
29+

‎docs/Built-In-Output-QRGdImage.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# QRGdImage
2+
3+
[Class `QRGdImage`](https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QRGdImage.php): [GdImage](https://www.php.net/manual/book.image) raster graphic output (GIF, JPG, PNG)
4+
5+
6+
## Options that affect this module
7+
8+
| property | type |
9+
|--------------------------------|----------------|
10+
| `$returnResource` | `bool` |
11+
| `$imageBase64` | `bool` |
12+
| `$bgColor` | `mixed` |
13+
| `$drawLightModules` | `bool` |
14+
| `$drawCircularModules` | `bool` |
15+
| `$circleRadius` | `float` |
16+
| `$keepAsSquare` | `array` |
17+
| `$scale` | `int` |
18+
| `$imageTransparent` | `bool` |
19+
| `$transparencyColor` | `mixed` |
20+
| `$pngCompression` | `int` |
21+
| `$jpegQuality` | `int` |
22+
23+
24+
### Options that have no effect
25+
26+
| property | reason |
27+
|--------------------------------|--------|
28+
| `$connectPaths` | N/A |
29+
| `$excludeFromConnect` | N/A |

‎docs/Built-In-Output-QRImagick.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# QRImagick
2+
3+
[Class `QRImagick`](https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QRImagick.php): [ImageMagick](https://www.php.net/manual/book.imagick) output, [multiple supported image formats](https://imagemagick.org/script/formats.php)
4+
5+
Please follow the installation guides for your operating system:
6+
7+
- ImageMagick: [imagemagick.org/script/download.php](https://imagemagick.org/script/download.php)
8+
- PHP `ext-imagick`: [github.com/Imagick/imagick](https://github.com/Imagick/imagick) ([Windows downloads](https://mlocati.github.io/articles/php-windows-imagick.html))
9+
- [PHP Imagick by Example](https://phpimagick.com/) ([github.com/Imagick/ImagickDemos](https://github.com/Imagick/ImagickDemos))
10+
11+
12+
## Options that affect this module
13+
14+
| property | type |
15+
|--------------------------------|----------------|
16+
| `$returnResource` | `bool` |
17+
| `$imageBase64` | `bool` |
18+
| `$bgColor` | `mixed` |
19+
| `$drawLightModules` | `bool` |
20+
| `$drawCircularModules` | `bool` |
21+
| `$circleRadius` | `float` |
22+
| `$keepAsSquare` | `array` |
23+
| `$scale` | `int` |
24+
| `$imageTransparent` | `bool` |
25+
| `$transparencyColor` | `mixed` |
26+
| `$imagickFormat` | `string` |
27+
28+
29+
### Options that have no effect
30+
31+
| property | reason |
32+
|--------------------------------|-------------------|
33+
| `$connectPaths` | N/A |
34+
| `$excludeFromConnect` | N/A |
35+
| `$pngCompression` | GdImage exclusive |
36+
| `$jpegQuality` | GdImage exclusive |

0 commit comments

Comments
 (0)