The following methods (property getters) have been deprecated in favor of asymmetric visibility, which is available as of PHP 8.4 and which is the minimum requirement of the next major version (v7) of php-qrcode.
The QRMatrix class will see an addition of a magic getter that emulates the future behaviour as an upgrade path, the other methods are only used internally and will see no such addition for the time being.

The following properties as well as the method copyVars() in QROutputAbstract will be removed in v7 without replacement,
as they only existed to improve performance by circumventing the magic getters in the QROptions class - these are replaced by (set) property hooks where unnecessary overhead is reduced. Some of the built-in output classes may see the re-addition of some of these properties locally, depending on the performance impact.

QROutputAbstract::$excludeFromConnect
QROutputAbstract::$keepAsSquare
QROutputAbstract::$connectPaths
QROutputAbstract::$eol
QROutputAbstract::$drawCircularModules
QROutputAbstract::$drawLightModules
QROutputAbstract::$circleRadius

These changes are already in dev-main.

6.0.1 Latest

Latest

Compare

Choose a tag to compare

Hi, I've kept you waiting for too long now, so I'm going to release it "as is". Originally I planned to add support for creating Structured Append QR Codes but I'm currently lacking the mental capacity to wrap my head around this concept (a method to calculate the parity already exists in the code, feel free to submit a PR!).

Once again, a big thank you to everyone who submitted issue reports and opened discussions and helped to improve this library!

IMPORTANT: v6 will be branched out and the main branch will remain the active development branch towards v7. If you have used the composer version dev-main without a commit hash in the past, please make sure to update the requirement ASAP. You have been warned.

For feedback and questions please head over to the linked discussion!

Changelog

• General
  • The required minimum PHP version is now 8.2.
  • The QRCode constructor now also accepts an iterable as options, which is handed over to a new QROptions instance internally.
  • Extracted QRMatrix::getBooleanMatrix() from QRMatrix::getMatrix() to remove type ambiguity, the optional parameter $boolean has been removed.
  • Added PHPBench to run benchmarks (the results can be found in the benchmark branch).
  • Several bugfixes, cleanup, dependency updates, documentation update and examples.
• Settings (QROptionsTrait)
  • [breaking] The property QROptions::$outputType and the related constants in QROutputInterface have been removed. The output type is now specified via QROptions::$outputInterface with the default value of QRMarkupSVG::class. (#223).
  • Split QR Code reader options into separate QRCodeReaderOptionsTrait.
  • The magic setter for QROptions::$eccLevel now also accepts the string values L, M, Q, H (case-insensitive) - these will be converted internally to the respective integers. (#160).
  • The property QROptions::$scale (module scaling for several raster image output classes) is now clamped between 1 and 50.
• Output (QROutputInterface and child classes)
  • [breaking] The parameter $transform of the method QROutputAbstract::collectModules(Closure $transform) has been removed in favor of a method QROutputAbstract::moduleTransform():mixed|null which is called with the same parameters.
  • Added QRInterventionImage (intervention/image) output.
  • Added XML output QRMarkupXML including an XSD schema qrcode.schema.xsd.
  • [possibly breaking] QRStringJSON overhaul, similar to XML output, including a JSON schema qrcode.schema.json.
  • The GD output class now also supports the avif format via QRGdImageAVIF.
  • QRFpdf::dump(): allow using external FPDF instance.
  • Extracted CssColorModuleValueTrait and RGBArrayModuleValueTrait for use in custom output classes.

6.0.0

Compare

Choose a tag to compare

• PHP 8.5 support (imagedestroy() deprecation)
• The parameter $transform of the method QROutputAbstract::collectModules(Closure $transform) has been deprecated in favor of the newly introduced method QROutputAbstract::moduleTransform() with the same parameters as the anonymous closure. The parameter will be removed in v6.
• Remaining instances of empty() have been replaced with more precise checks.
• dependency & CI updates

5.0.5

Compare

Choose a tag to compare

• hand over finder pattern coordinates to the decoder result (#248)
• fixed a bug in the AlphaNum string validator and added additional tests (#313)
• dependency updates

5.0.4

Compare

Choose a tag to compare

• PHP 8.4 support (implicit nullable types are deprecated) (#276)
• ECI decoding now allows for numeric and alphanumeric segments to be preceded by an ECI designator (#289)
• simplified Number and AlphaNum classes (backport from dev-main. v6)
• QRFpdf::dump() now accepts an FPDF instance as second optional parameter
• dependency & CI updates
  • fixed the broken PHPCS config
  • added Slevomat Coding Standard
  • added PHP Compatibility Coding Standard
• added PHPStorm code style

5.0.3

Compare

Choose a tag to compare

• fixed a bug in the QR Code version auto detection when the given data segment was the exact same bit size as the maximum for the guessed provisional version, added a safety margin of 4 bits, which forces the next available version in that case.

5.0.2

Compare

Choose a tag to compare

• ReedSolomonDecoder now throws a QRCodeDecoderException instead of the generic QRCodeException
• added a .gitattributes file (#234)
• minor performance (QRMatrix) and type safety (MaskPattern) improvements
• branch adjustments
• dependency updates
• test cleanup and improvements

5.0.1

Compare

Choose a tag to compare

Hi! It's been a while since the last major version - has it already been over three years and seven million downloads??? Time flies...
v5 was supposed to be released earlier this year already, but various health issues kept me from working on it and I kept y'all waiting and using dev-main and the v5-beta instead - but hey, the wait is over now!

The new version comes with countless internal changes, mostly to incooperate the ZXing QR Code reader and open the possibility for other types of barcodes, such as micro QR.
A lot of things have been deprecated and moved in order to clean up for v6 which is intended to support PHP 8.2+ (or maybe 8.3+ even). See the attached discussion thread for a full list of changes and deprecations.

IMPORTANT: v5 will be branched out and the main branch will become (or rather remain) the active development branch towards v6. If you have used the composer version dev-main without a commit hash in the past, please make sure to update the requirement ASAP. You have been warned.

Also, a big thank you to everyone who submitted issue reports and opened discussions and helped to improve this library!

New Features

• QR Code reader based on a PHP port of the ZXing library
  • MIT and Apache 2.0 dual licensing to accommodate the ZXing related files, see: NOTICE
• Proper mixed mode support (several data mode segments can appear in the same QR symbol)
  • Simplified Chinese (Hanzi/GB2312) support according to GBT18284-2000
  • ECI mode support
  • Structured append mode (not yet...)
• Full "reversed reflectance" support (inverted matrix colors)
• Encapsulated Postscript (EPS) output
• An all new documentation at https://php-qrcode.readthedocs.io/en/v5.0.x/ in favor over the wiki
• A truckload of new examples

Changes

• [breaking] The default output has been changed from PNG (GdImage) to SVG. No image processing extension (ext-gd or ext-imagick) required anymore!
• [breaking] The default output format of the built-in output classes is now a base64 data URI (if applicable) so that it can be directly embedded as src into an <img> tag. This can be disabled by setting QROptions::$outputBase64 to false.
• [breaking] The default value of QROptions::$imageTransparent has been set to false due to various issues and misconceptions with transparency in GD and ImageMagick, therefore: use at your own risk.
• [breaking] The values of the QRMatrix::M_* constants and therefore the keys of the QROptions::$moduleValues array have changed. QRMatrix::M_*_DARK constants have been introduced for convenience. The module values are now a proper bitmask, the dark value is now calculated (QRMatrix::M_* | QRMatrix::IS_DARK) instead of (QRMatrix::M_* << 8).
• [breaking] The output class QRMarkup has been changed to abstract, inheritors are now QRMarkupHTML and QRMarkupSVG (QRMarkupXML anyone?).
• [possibly breaking] The fill-opacity attribute (and its respective setting QROptions::$svgOpacity) has been removed from QRMarkupSVG::path() as it can be set by CSS.
• [possibly breaking] The QROptions::$markupDark and QROptions::$markupLight settings have been removed - they can be set via overriding QRMarkup::getDefaultModuleValue().
• [possibly breaking] The QROptions::$textDark and QROptions::$textLight settings have been removed - they can be set via overriding QRString::getDefaultModuleValue().
• The module value validation method QROutputInterface::moduleValueIsValid() is now public static, so that input values can be checked before invoking the options, e.g. QRMarkupSVG::moduleValueIsValid('#aabbcc'). Please note that in case of HTML and SVG it will only check for the basic syntax, it will not validate or sanitize the values.
• The GD output class now also supports BMP and WEBP output.
• The formerly GD exclusive options QROptions::$jpegQuality and QROptions::$pngCompression have been deprecated in favor of the more generic QROptions::$quality.
• The setting QROptions::$svgUseFillAttributes has been added to toggle fill attributes on the SVG <path> elements in QRMarkupSVG::path() (this was previously done via setting QROptions::$markupDark and QROptions::$markupLight to an empty value).

5.0.0

Compare

Choose a tag to compare

• PHP 8.4 support (implicit nullable types are deprecated)
• dependency & CI updates

4.4.2

Compare

Choose a tag to compare

• added a .gitattributes file (#234)
• dependency updates

4.4.1

Compare

Choose a tag to compare