v5.0.0 release

[codemasher]

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/ 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).

API

The full API documentation can be found under https://chillerlan.github.io/php-qrcode/

class names are relative from the namespace chillerlan\QRCode, only public facing items are listed

Changed/Moved

without deprecation

v4.3.x (old)	v5.x (new)
\QRCode::getMatrix(string $data)	\QRCode::getMatrix()
\QROptions::$moduleValues (array|null)	\QROptions::$moduleValues (array)
\Helpers\BitBuffer::class	\Common\BitBuffer::class
\Data\QRMatrix::__construct(int $version, int $eclevel)	\Data\QRMatrix::__construct(Version $version, EccLevel $eccLevel)
\Data\QRMatrix::init(int $maskPattern, bool $test = null)	\Data\QRMatrix::initFunctionalPatterns()
\Data\QRMatrix::setFormatInfo(int $maskPattern, bool $test = null)	\Data\QRMatrix::setFormatInfo(MaskPattern $maskPattern = null)
\Data\QRMatrix::setQuietZone(int $size = null)	\Data\QRMatrix::setQuietZone(int $quietZoneSize)
\Data\QRMatrix::setVersionNumber(bool $test = null)	\Data\QRMatrix::setVersionNumber()
\Data\QRMatrix::mapData(array $data, int $maskPattern)	\Data\QRMatrix::writeCodewords(BitBuffer $bitBuffer)

deprecated

The following items are deprecated as of v5 and will be removed in v6.

v4.3.x (deprecated)	v5.x (new)
\QRCode::VERSION_AUTO	\Common\Version::AUTO
\QRCode::MASK_PATTERN_AUTO	\Common\MaskPattern::AUTO
\QRCode::ECC_L	\Common\EccLevel::L
\QRCode::ECC_M	\Common\EccLevel::M
\QRCode::ECC_Q	\Common\EccLevel::Q
\QRCode::ECC_H	\Common\EccLevel::H
\QRCode::OUTPUT_MARKUP_HTML	\Output\QROutputInterface::MARKUP_HTML (also deprecated)
\QRCode::OUTPUT_MARKUP_SVG	\Output\QROutputInterface::MARKUP_SVG (also deprecated)
\QRCode::OUTPUT_IMAGE_PNG	\Output\QROutputInterface::GDIMAGE_PNG (also deprecated)
\QRCode::OUTPUT_IMAGE_JPG	\Output\QROutputInterface::GDIMAGE_JPG (also deprecated)
\QRCode::OUTPUT_IMAGE_GIF	\Output\QROutputInterface::GDIMAGE_GIF (also deprecated)
\QRCode::OUTPUT_STRING_JSON	\Output\QROutputInterface::STRING_JSON (also deprecated)
\QRCode::OUTPUT_STRING_TEXT	\Output\QROutputInterface::STRING_TEXT (also deprecated)
\QRCode::OUTPUT_IMAGICK	\Output\QROutputInterface::IMAGICK (also deprecated)
\QRCode::OUTPUT_FPDF	\Output\QROutputInterface::FPDF (also deprecated)
\QRCode::OUTPUT_EPS	\Output\QROutputInterface::EPS (also deprecated)
\QRCode::OUTPUT_CUSTOM	\Output\QROutputInterface::CUSTOM (also deprecated)
\QRCode::OUTPUT_MODES	\Output\QROutputInterface::MODES (also deprecated)
\QRCode::getMatrix()	\QRCode::getQRMatrix()
\QRCode::isNumber()	\Data\Number::validateString()
\QRCode::isAlphaNum()	\Data\AlphaNum::validateString()
\QRCode::isKanji()	\Data\Kanji::validateString()
\QRCode::isByte()	\Data\Byte::validateString()
\QROptions::$imageBase64	\QROptions::$outputBase64
\QROptions::$imageTransparencyBG (array)	\QROptions::$transparencyColor (mixed)
\QROptions::$imagickBG (string)	\QROptions::$bgColor (mixed)
\QROptions::$outputType	\QROptions::$outputInterface
\QROptions::$pngCompression	\QROptions::$quality
\QROptions::$jpegQuality	\QROptions::$quality
\Data\QRMatrix::eccLevel()	\Data\QRMatrix::getEccLevel()
\Data\QRMatrix::maskPattern()	\Data\QRMatrix::getMaskPattern()
\Data\QRMatrix::matrix(bool $boolean = null)	\Data\QRMatrix::getMatrix(bool $boolean = null)
\Data\QRMatrix::size()	\Data\QRMatrix::getSize()
\Data\QRMatrix::version()	\Data\QRMatrix::getVersion()
\Output\QRImage::class	\Output\QRGdImage::class
\Output\QRString::class	\Output\QRStringText::class and \Output\QRStringJSON::class

Added

v5.x (new)
\QRCode::addSegment(QRDataModeInterface $segment)
\QRCode::addNumericSegment(string $data)
\QRCode::addAlphaNumSegment(string $data)
\QRCode::addByteSegment(string $data)
\QRCode::addHanziSegment(string $data)
\QRCode::addKanjiSegment(string $data)
\QRCode::addEciDesignator(int $encoding)
\QRCode::addEciSegment(int $encoding, string $data)
\QRCode::clearSegments()
\QRCode::readFromBlob(string $blob)
\QRCode::readFromFile(string $path)
\QRCode::readFromSource(LuminanceSourceInterface $source)
\QRCode::renderMatrix(QRMatrix $matrix, string $file = null)
\QRCode::setOptions(SettingsContainerInterface $options)
\QROptions::$addLogoSpace
\QROptions::$bgColor
\QROptions::$circleRadius
\QROptions::$connectPaths
\QROptions::$drawCircularModules
\QROptions::$drawLightModules
\QROptions::$excludeFromConnect
\QROptions::$gdImageUseUpscale
\QROptions::$invertMatrix
\QROptions::$jsonAsBooleans
\QROptions::$jsonFlags
\QROptions::$keepAsSquare
\QROptions::$logoSpaceWidth
\QROptions::$logoSpaceHeight
\QROptions::$logoSpaceStartX
\QROptions::$logoSpaceStartY
\QROptions::$readerUseImagickIfAvailable
\QROptions::$readerGrayscale
\QROptions::$readerInvertColors
\QROptions::$readerIncreaseContrast
\QROptions::$svgPreserveAspectRatio
\QROptions::$svgUseFillAttributes
\QROptions::$textLineStart
\Common\EccLevel::class
\Common\ECICharset::class
\Common\MaskPattern::class
\Common\Mode::class
\Common\Version::class
\Data\QRMatrix::IS_DARK
\Data\QRMatrix::M_DARKMODULE_LIGHT
\Data\QRMatrix::M_DATA_DARK
\Data\QRMatrix::M_FINDER_DARK
\Data\QRMatrix::M_FINDER_DOT_LIGHT
\Data\QRMatrix::M_ALIGNMENT_DARK
\Data\QRMatrix::M_TIMING_DARK
\Data\QRMatrix::M_FORMAT_DARK
\Data\QRMatrix::M_VERSION_DARK
\Data\QRMatrix::M_QUIETZONE_DARK
\Data\QRMatrix::M_LOGO_DARK
\Data\QRMatrix::M_SEPARATOR_DARK
\Data\QRMatrix::checkType(int $x, int $y, int $M_TYPE)
\Data\QRMatrix::checkTypeIn(int $x, int $y, array $M_TYPES)
\Data\QRMatrix::checkNeighbours(int $x, int $y, int $M_TYPE_VALUE = null)
\Data\QRMatrix::flip()
\Data\QRMatrix::invert()
\Data\QRMatrix::isDark(int $M_TYPE)
\Data\QRMatrix::mask()
\Data\QRMatrix::rotate90()
\Data\QRMatrix::setArea(int $startX, int $startY, int $width, int $height, bool $value, int $M_TYPE)
\Decoder\Decoder::class
\Decoder\DecoderResult::class
\Decoder\GDLuminanceSource::class
\Decoder\IMagickLuminanceSource::class
\Decoder\LuminanceSourceInterface::class
\Data\Hanzi::class
\Data\ECI::class
\Data\QRData::class
\Data\QRDataModeInterface::class
\Data\QRDataModeAbstract::class
\Output\QROutputInterface::moduleValueIsValid($value)
\Output\QREps::class
\Output\QRMarkupHTML::class
\Output\QRMarkupSVG::class

Removed

v4.3.x (old)	reason
\QRCode::initDataInterface()	data mode overhaul
\QROptions::$dataModeOverride	data mode overhaul
\QROptions::$svgOpacity	override QRMarkupSVG::path() instead
\QROptions::$svgViewBoxSize	misconception, override QRMarkupSVG::getViewBox() instead (#222)
\QROptions::$markupDark	override QRMarkup::getDefaultModuleValue() instead
\QROptions::$markupLight	override QRMarkup::getDefaultModuleValue() instead
\QROptions::$textDark	override QRString::getDefaultModuleValue() instead
\QROptions::$textLight	override QRString::getDefaultModuleValue() instead
\Data\QRDataAbstract::class	data mode overhaul
\Data\QRDataInterface::class	data mode overhaul
\Data\QRMatrix::M_TEST	unnecessary

---

This discussion was created from the release 5.0.0.