|
|
@@ -6,6 +6,7 @@ QR Code version number
|
|
|
|
|
|
`1 ... 40` or `Version::AUTO` (default)
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `\chillerlan\QRCode\Common\Version`
|
|
|
@@ -36,6 +37,7 @@ Error correct level
|
|
|
- `Q` => 25%
|
|
|
- `H` => 30%
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `\chillerlan\QRCode\Common\EccLevel`
|
|
|
@@ -48,6 +50,7 @@ Mask Pattern to use (no value in using, mostly for unit testing purposes)
|
|
|
|
|
|
`0 ... 7` or `MaskPattern::PATTERN_AUTO` (default)
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `\chillerlan\QRCode\Common\MaskPattern`
|
|
|
@@ -57,6 +60,7 @@ Mask Pattern to use (no value in using, mostly for unit testing purposes)
|
|
|
|
|
|
Add a "quiet zone" (margin) according to the QR code spec
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- [www.qrcode.com/en/howto/code.html](https://www.qrcode.com/en/howto/code.html)
|
|
|
@@ -87,6 +91,9 @@ The built-in output type
|
|
|
- `QROutputInterface::FPDF`
|
|
|
- `QROutputInterface::CUSTOM`
|
|
|
|
|
|
+
|
|
|
+**Deprecated:** 5.0.0 see issue #223
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `\chillerlan\QRCode\Output\QREps`
|
|
|
@@ -96,6 +103,7 @@ The built-in output type
|
|
|
- `\chillerlan\QRCode\Output\QRMarkupHTML`
|
|
|
- `\chillerlan\QRCode\Output\QRMarkupSVG`
|
|
|
- `\chillerlan\QRCode\Output\QRString`
|
|
|
+- [github.com/chillerlan/php-qrcode/issues/223](https://github.com/chillerlan/php-qrcode/issues/223)
|
|
|
|
|
|
|
|
|
## outputInterface
|
|
|
@@ -104,6 +112,9 @@ The FQCN of the custom `QROutputInterface`
|
|
|
|
|
|
if `QROptions::$outputType` is set to `QROutputInterface::CUSTOM` (default: `null`)
|
|
|
|
|
|
+**Deprecated:** 5.0.0 the nullable type will be removed in future versions
|
|
|
+and the default value will be set to `QRMarkupSVG::class`
|
|
|
+
|
|
|
|
|
|
## returnResource
|
|
|
|
|
|
@@ -116,6 +127,7 @@ Return the image resource instead of a render if applicable.
|
|
|
This option overrides/ignores other output settings, such as `QROptions::$cachefile`
|
|
|
and `QROptions::$outputBase64`. (default: `false`)
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `\chillerlan\QRCode\Output\QROutputInterface::dump()`
|
|
|
@@ -128,6 +140,7 @@ Optional cache file path `/path/to/cache.file`
|
|
|
Please note that the `$file` parameter in `QRCode::render()` and `QRCode::renderMatrix()`
|
|
|
takes precedence over the `QROptions::$cachefile` value. (default: `null`)
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `\chillerlan\QRCode\QRCode::render()`
|
|
|
@@ -140,6 +153,7 @@ Toggle base64 data URI or raw data output (if applicable)
|
|
|
|
|
|
(default: `true`)
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `\chillerlan\QRCode\Output\QROutputAbstract::toBase64DataURI()`
|
|
|
@@ -168,6 +182,7 @@ Whether to invert the matrix (reflectance reversal)
|
|
|
|
|
|
(default: `false`)
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `\chillerlan\QRCode\Data\QRMatrix::invert()`
|
|
|
@@ -191,6 +206,7 @@ using `imagefilledellipse()` and then scaled back to the expected size
|
|
|
|
|
|
No effect in: `QREps`, `QRFpdf`, `QRMarkupHTML`
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- [php.net: `\imagefilledellipse()`](https://www.php.net/manual/function.imagefilledellipse)
|
|
|
@@ -216,6 +232,7 @@ Specifies which module types to exclude when `QROptions::$drawCircularModules` i
|
|
|
|
|
|
Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- [github.com/chillerlan/php-qrcode/issues/57](https://github.com/chillerlan/php-qrcode/issues/57)
|
|
|
@@ -234,6 +251,7 @@ Module values map
|
|
|
- `QREps`, `QRFpdf`, `QRGdImage`: `[R, G, B]` // 0-255
|
|
|
- `QREps`: `[C, M, Y, K]` // 0-255
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `\chillerlan\QRCode\Output\QROutputAbstract::setModuleValues()`
|
|
|
@@ -243,6 +261,7 @@ Module values map
|
|
|
|
|
|
Toggles logo space creation
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `\chillerlan\QRCode\QRCode::addMatrixModifications()`
|
|
|
@@ -284,6 +303,7 @@ Toggle transparency
|
|
|
|
|
|
- `QRGdImage` and `QRImagick`: the given `QROptions::$transparencyColor` is set as transparent
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- [github.com/chillerlan/php-qrcode/discussions/121](https://github.com/chillerlan/php-qrcode/discussions/121)
|
|
|
@@ -299,6 +319,7 @@ Defaults to `QROptions::$bgColor`.
|
|
|
- `QRImagick`: `"color_str"`, this color is set in `Imagick::transparentPaintImage()`
|
|
|
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- [php.net: `\imagecolortransparent()`](https://www.php.net/manual/function.imagecolortransparent)
|
|
|
@@ -311,11 +332,12 @@ Compression quality
|
|
|
|
|
|
The given value depends on the used output type:
|
|
|
|
|
|
-- `QROutputInterface::GDIMAGE_BMP`: `[0...1]`
|
|
|
-- `QROutputInterface::GDIMAGE_JPG`: `[0...100]`
|
|
|
-- `QROutputInterface::GDIMAGE_WEBP`: `[0...9]`
|
|
|
-- `QROutputInterface::GDIMAGE_PNG`: `[0...100]`
|
|
|
-- `QROutputInterface::IMAGICK`: `[0...100]`
|
|
|
+- `QRGdImageBMP`: `[0...1]`
|
|
|
+- `QRGdImageJPEG`: `[0...100]`
|
|
|
+- `QRGdImageWEBP`: `[0...9]`
|
|
|
+- `QRGdImagePNG`: `[0...100]`
|
|
|
+- `QRImagick`: `[0...100]`
|
|
|
+
|
|
|
|
|
|
**See also:**
|
|
|
|
|
|
@@ -326,10 +348,23 @@ The given value depends on the used output type:
|
|
|
- [php.net: `\Imagick::setImageCompressionQuality()`](https://www.php.net/manual/imagick.setimagecompressionquality)
|
|
|
|
|
|
|
|
|
+## gdImageUseUpscale
|
|
|
+
|
|
|
+Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and
|
|
|
+`QROptions::$scale` is less than 20
|
|
|
+
|
|
|
+
|
|
|
+**See also:**
|
|
|
+
|
|
|
+- `\chillerlan\QRCode\Output\QRGdImage::createImage()`
|
|
|
+- [github.com/chillerlan/php-qrcode/issues/23](https://github.com/chillerlan/php-qrcode/issues/23)
|
|
|
+
|
|
|
+
|
|
|
## imagickFormat
|
|
|
|
|
|
Imagick output format
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- [php.net: `\Imagick::setImageFormat()`](https://www.php.net/manual/imagick.setimageformat)
|
|
|
@@ -352,6 +387,7 @@ Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML
|
|
|
|
|
|
Anything in the SVG `<defs>` tag
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- [developer.mozilla.org/en-US/docs/Web/SVG/Element/defs](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs)
|
|
|
@@ -361,6 +397,7 @@ Anything in the SVG `<defs>` tag
|
|
|
|
|
|
Sets the value for the "preserveAspectRatio" on the `<svg>` element
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- [developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio)
|
|
|
@@ -373,6 +410,7 @@ Whether to use the SVG `fill` attributes
|
|
|
If set to `true` (default), the `fill` attribute will be set with the module value for the `<path>` element's `$M_TYPE`.
|
|
|
When set to `false`, the module values map will be ignored and the QR Code may be styled via CSS.
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- [developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill)
|
|
|
@@ -383,6 +421,16 @@ When set to `false`, the module values map will be ignored and the QR Code may b
|
|
|
An optional line prefix, e.g. empty space to align the QR Code in a console
|
|
|
|
|
|
|
|
|
+## jsonFlags
|
|
|
+
|
|
|
+Sets the flags to use for the `json_encode()` call
|
|
|
+
|
|
|
+
|
|
|
+**See also:**
|
|
|
+
|
|
|
+- [www.php.net/manual/json.constants.php](https://www.php.net/manual/json.constants.php)
|
|
|
+
|
|
|
+
|
|
|
## jsonAsBooleans
|
|
|
|
|
|
Whether to return matrix values in JSON as booleans or `$M_TYPE` integers
|
|
|
@@ -392,6 +440,7 @@ Whether to return matrix values in JSON as booleans or `$M_TYPE` integers
|
|
|
|
|
|
Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)
|
|
|
|
|
|
+
|
|
|
**See also:**
|
|
|
|
|
|
- `FPDF::__construct()`
|
|
|
@@ -407,9 +456,59 @@ Use Imagick (if available) when reading QR Codes
|
|
|
Grayscale the image before reading
|
|
|
|
|
|
|
|
|
+## readerInvertColors
|
|
|
+
|
|
|
+Invert the colors of the image
|
|
|
+
|
|
|
+
|
|
|
## readerIncreaseContrast
|
|
|
|
|
|
Increase the contrast before reading
|
|
|
|
|
|
note that applying contrast works different in GD and Imagick, so mileage may vary
|
|
|
|
|
|
+
|
|
|
+## imageBase64
|
|
|
+
|
|
|
+**Deprecated:** 5.0.0 use QROptions::$outputBase64 instead
|
|
|
+
|
|
|
+**See also:**
|
|
|
+
|
|
|
+- ` \chillerlan\QRCode\QROptions::$outputBase64`
|
|
|
+
|
|
|
+
|
|
|
+## jpegQuality
|
|
|
+
|
|
|
+**Deprecated:** 5.0.0 use QROptions::$quality instead
|
|
|
+
|
|
|
+**See also:**
|
|
|
+
|
|
|
+- ` \chillerlan\QRCode\QROptions::$quality`
|
|
|
+
|
|
|
+
|
|
|
+## pngCompression
|
|
|
+
|
|
|
+**Deprecated:** 5.0.0 use QROptions::$quality instead
|
|
|
+
|
|
|
+**See also:**
|
|
|
+
|
|
|
+- ` \chillerlan\QRCode\QROptions::$quality`
|
|
|
+
|
|
|
+
|
|
|
+## imageTransparencyBG
|
|
|
+
|
|
|
+**Deprecated:** 5.0.0 use QROptions::$transparencyColor instead
|
|
|
+
|
|
|
+**See also:**
|
|
|
+
|
|
|
+- ` \chillerlan\QRCode\QROptions::$transparencyColor`
|
|
|
+
|
|
|
+
|
|
|
+## imagickBG
|
|
|
+
|
|
|
+**Deprecated:** 5.0.0 use QROptions::$bgColor instead
|
|
|
+
|
|
|
+**See also:**
|
|
|
+
|
|
|
+- ` \chillerlan\QRCode\QROptions::$bgColor`
|
|
|
+
|