New major

Author: endroid

.github/workflows/CI.yml

@@ -54,6 +54,13 @@ jobs:
           vendor/bin/unit-test
           vendor/bin/functional-test ^3.4
 
+      - name: Archive logs
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: logs
+          path: vendor/endroid/quality/application/var/log
+
       - name: Archive code coverage results
         uses: actions/upload-artifact@v2
         with:

README.md

@@ -13,7 +13,7 @@ to generate the matrix and [khanamiryan/qrcode-detector-decoder](https://github.
 for validating generated QR codes. Further extended with Twig extensions, generation routes, a factory and a
 Symfony bundle for easy installation and configuration.
 
-Different writers are provided to generate the QR code as PNG, SVG, EPS, PDF or in binary format.
+Different writers are provided to generate the QR code as PNG, SVG, EPS or in binary format.
 
 ## Installation
 
@@ -23,49 +23,75 @@ Use [Composer](https://getcomposer.org/) to install the library.
 $ composer require endroid/qr-code
 ```
 
-## Basic usage
+## Usage: without using builder
 
 ```php
+use Endroid\QrCode\Color\Color;
+use Endroid\QrCode\Encoding\Encoding;
+use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelLow;
 use Endroid\QrCode\QrCode;
+use Endroid\QrCode\Label\Label;
+use Endroid\QrCode\Logo\Logo;
+use Endroid\QrCode\RoundBlockSizeMode\RoundBlockSizeModeMargin;
+use Endroid\QrCode\Writer\PngWriter;
+
+$writer = new PngWriter();
+
+// Create QR code
+$qrCode = QrCode::create('Data')
+    ->setEncoding(new Encoding('UTF-8'))
+    ->setErrorCorrectionLevel(new ErrorCorrectionLevelLow())
+    ->setSize(300)
+    ->setMargin(10)
+    ->setRoundBlockSizeMode(new RoundBlockSizeModeMargin())
+    ->setForegroundColor(new Color(0, 0, 0))
+    ->setBackgroundColor(new Color(255, 255, 255));
+
+// Create generic logo
+$logo = Logo::create(__DIR__.'/assets/symfony.png')
+    ->setResizeToWidth(50);
+
+// Create generic label
+$label = Label::create('Label')
+    ->setTextColor(new Color(255, 0, 0))
+    ->setBackgroundColor(new Color(0, 0, 0));
+
+$result = $writer->write($qrCode, $logo, $label);
+```
 
-$qrCode = new QrCode('Life is too short to be generating QR codes');
+## Usage: using the builder
 
-header('Content-Type: '.$qrCode->getContentType());
-echo $qrCode->writeString();
+```php
+use Endroid\QrCode\Builder\Builder;
+use Endroid\QrCode\Encoding\Encoding;
+use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelHigh;
+use Endroid\QrCode\Label\Alignment\LabelAlignmentCenter;
+use Endroid\QrCode\Label\Font\NotoSans;
+use Endroid\QrCode\RoundBlockSizeMode\RoundBlockSizeModeMargin;
+use Endroid\QrCode\Writer\PngWriter;
+
+$result = Builder::create()
+    ->writer(new PngWriter())
+    ->writerOptions([])
+    ->data('Custom QR code contents')
+    ->encoding(new Encoding('UTF-8'))
+    ->errorCorrectionLevel(new ErrorCorrectionLevelHigh())
+    ->size(300)
+    ->margin(10)
+    ->roundBlockSizeMode(new RoundBlockSizeModeMargin())
+    ->logoPath(__DIR__.'/assets/symfony.png')
+    ->labelText('This is the label')
+    ->labelFont(new NotoSans(20))
+    ->labelAlignment(new LabelAlignmentCenter())
+    ->build();
 ```
 
-## Advanced usage
+## Usage: working with results
 
 ```php
-use Endroid\QrCode\ErrorCorrectionLevel;
-use Endroid\QrCode\LabelAlignment;
-use Endroid\QrCode\QrCode;
-use Endroid\QrCode\Response\QrCodeResponse;
-
-// Create a basic QR code
-$qrCode = new QrCode('Life is too short to be generating QR codes');
-$qrCode->setSize(300);
-$qrCode->setMargin(10); 
-
-// Set advanced options
-$qrCode->setWriterByName('png');
-$qrCode->setEncoding('UTF-8');
-$qrCode->setErrorCorrectionLevel(ErrorCorrectionLevel::HIGH());
-$qrCode->setForegroundColor(['r' => 0, 'g' => 0, 'b' => 0, 'a' => 0]);
-$qrCode->setBackgroundColor(['r' => 255, 'g' => 255, 'b' => 255, 'a' => 0]);
-$qrCode->setLabel('Scan the code', 16, __DIR__.'/../assets/fonts/noto_sans.otf', LabelAlignment::CENTER());
-$qrCode->setLogoPath(__DIR__.'/../assets/images/symfony.png');
-$qrCode->setLogoSize(150, 200);
-$qrCode->setValidateResult(false);
-
-// Round block sizes to improve readability and make the blocks sharper in pixel based outputs (like png).
-// There are three approaches:
-$qrCode->setRoundBlockSize(true, QrCode::ROUND_BLOCK_SIZE_MODE_MARGIN); // The size of the qr code is shrinked, if necessary, but the size of the final image remains unchanged due to additional margin being added (default)
-$qrCode->setRoundBlockSize(true, QrCode::ROUND_BLOCK_SIZE_MODE_ENLARGE); // The size of the qr code and the final image is enlarged, if necessary
-$qrCode->setRoundBlockSize(true, QrCode::ROUND_BLOCK_SIZE_MODE_SHRINK); // The size of the qr code and the final image is shrinked, if necessary
 
 // Set additional writer options (SvgWriter example)
-$qrCode->setWriterOptions(['exclude_xml_declaration' => true]);
+$qrCode->
 
 // Directly output the QR code
 header('Content-Type: '.$qrCode->getContentType());
@@ -80,12 +106,37 @@ $dataUri = $qrCode->writeDataUri();
 
 ![QR Code](https://endroid.nl/qr-code/Life%20is%20too%20short%20to%20be%20generating%20QR%20codes.png)
 
+### Writer options
+
+```php
+use Endroid\QrCode\Writer\SvgWriter;
+
+$builder->setWriterOptions([SvgWriter::WRITER_OPTION_EXCLUDE_XML_DECLARATION => true]);
+```
+
 ### Encoding
-You can pick one of these values for encoding:
 
-`ISO-8859-1`, `ISO-8859-2`, `ISO-8859-3`, `ISO-8859-4`, `ISO-8859-5`, `ISO-8859-6`, `ISO-8859-7`, `ISO-8859-8`, `ISO-8859-9`, `ISO-8859-10`, `ISO-8859-11`, `ISO-8859-12`, `ISO-8859-13`, `ISO-8859-14`, `ISO-8859-15`, `ISO-8859-16`, `Shift_JIS`, `windows-1250`, `windows-1251`, `windows-1252`, `windows-1256`, `UTF-16BE`, `UTF-8`, `US-ASCII`, `GBK` `EUC-KR`
+If you use a barcode scanner you can have some troubles while reading the
+generated QR codes. Depending on the encoding you chose you will have an extra
+amount of data corresponding to the ECI block. Some barcode scanner are not
+programmed to interpret this block of information. To ensure a maximum
+compatibility you can use the `ISO-8859-1` encoding that is the default
+encoding used by barcode scanners (if your character set supports it,
+i.e. no Chinese characters are present).
 
-If you use a barcode scanner you can have some troubles while reading the generated QR codes. Depending on the encoding you chose you will have an extra amount of data corresponding to the ECI block. Some barcode scanner are not programmed to interpret this block of information. For exemple the ECI block for `UTF-8` is `000026` so the above exemple will produce : `\000026Life is too short to be generating QR codes`. To ensure a maximum compatibility you can use the `ISO-8859-1` encoding that is the default encoding used by barcode scanners.
+### Round block size mode
+
+By default block sizes are rounded to guarantee sharp images and improve
+readability. However some other rounding variants are available.
+
+* RoundBlockSizeModeMargin (default): the size of the QR code is shrunk if
+  necessary but the size of the final image remains unchanged due to additional
+  margin being added.
+* RoundBlockSizeModeEnlarge: the size of the QR code and the final image are
+  enlarged when rounding differences occur.
+* RoundBlockSizeModeShrink: the size of the QR code and the final image are
+  shrunk when rounding differences occur.
+* RoundBlockSizeModeNone: No rounding.
 
 ## Readability
 
@@ -95,24 +146,25 @@ can tweak these parameters if you are looking for optimal results. You can also
 check $qrCode->getRoundBlockSize() value to see if block dimensions are rounded
 so that the image is more sharp and readable. Please note that rounding block
 size can result in additional padding to compensate for the rounding difference.
+And finally the encoding (default UTF-8 to support large character sets) can be
+set to `ISO-8859-1` if possible to improve readability.
 
 ## Built-in validation reader
 
 You can enable the built-in validation reader (disabled by default) by calling
 setValidateResult(true). This validation reader does not guarantee that the QR
 code will be readable by all readers but it helps you provide a minimum level
-of quality.
-
-Take note that the validator can consume quite amount of additional resources.
+of quality. Take note that the validator can consume quite amount of additional
+resources and it should be installed separately only if you use it.
 
 ## Symfony integration
 
 The [endroid/qr-code-bundle](https://github.com/endroid/qr-code-bundle)
 integrates the QR code library in Symfony for an even better experience.
 
 * Configure your defaults (like image size, default writer etc.)
-* Generate QR codes quickly from anywhere via the factory service
-* Generate QR codes directly by typing an URL like /qr-code/\<text>.png?size=300
+* Support for multiple configurations and injection via aliases
+* Generate QR codes for defined configurations via URL like /qr-code/<config>/Hello
 * Generate QR codes or URLs directly from Twig using dedicated functions
 
 Read the [bundle documentation](https://github.com/endroid/qr-code-bundle)

assets/fonts/noto_sans.otf renamed to assets/noto_sans.otf

@@ -1,7 +1,7 @@
 {
     "name": "endroid/qr-code",
     "description": "Endroid QR Code",
-    "keywords": ["endroid", "qrcode", "qr", "code", "bundle", "php"],
+    "keywords": ["endroid", "qrcode", "qr", "code", "php"],
     "homepage": "https://github.com/endroid/qr-code",
     "type": "library",
     "license": "MIT",
@@ -13,20 +13,19 @@
     ],
     "require": {
         "php": "^7.3||^8.0",
-        "bacon/bacon-qr-code": "^2.0",
-        "khanamiryan/qrcode-detector-decoder": "^1.0.2",
-        "myclabs/php-enum": "^1.5",
-        "symfony/options-resolver": "^3.4||^4.4||^5.0",
-        "symfony/property-access": "^3.4||^4.4||^5.0"
+        "bacon/bacon-qr-code": "^2.0"
     },
     "require-dev": {
-        "endroid/quality": "^1.5.2",
-        "setasign/fpdf": "^1.8"
+        "ext-gd": "*",
+        "endroid/quality": "dev-master",
+        "khanamiryan/qrcode-detector-decoder": "^1.0.4",
+        "setasign/fpdf": "^1.8.2"
     },
     "suggest": {
-        "ext-gd": "Required for generating PNG images",
-        "roave/security-advisories": "Avoids installation of package versions with vulnerabilities",
-        "setasign/fpdf": "Required to use the FPDF writer.",
+        "ext-gd": "Enables you to write PNG images",
+        "khanamiryan/qrcode-detector-decoder": "Enables you to use the image validator",
+        "roave/security-advisories": "Makes sure package versions with known security issues are not installed",
+        "setasign/fpdf": "Enables you to use the PDF writer.",
         "symfony/security-checker": "Checks your composer.lock for vulnerabilities"
     },
     "autoload": {
@@ -44,7 +43,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "3.x-dev"
+            "dev-master": "4.x-dev"
         }
     }
 }

assets/fonts/open_sans.ttf renamed to assets/open_sans.ttf

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Endroid\QrCode\Bacon;
+
+use BaconQrCode\Common\ErrorCorrectionLevel;
+use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelHigh;
+use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelInterface;
+use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelLow;
+use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelMedium;
+use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelQuartile;
+
+final class ErrorCorrectionLevelConverter
+{
+    public static function convertToBaconErrorCorrectionLevel(ErrorCorrectionLevelInterface $errorCorrectionLevel): ErrorCorrectionLevel
+    {
+        if ($errorCorrectionLevel instanceof ErrorCorrectionLevelLow) {
+            return ErrorCorrectionLevel::valueOf('L');
+        } elseif ($errorCorrectionLevel instanceof ErrorCorrectionLevelMedium) {
+            return ErrorCorrectionLevel::valueOf('M');
+        } elseif ($errorCorrectionLevel instanceof ErrorCorrectionLevelQuartile) {
+            return ErrorCorrectionLevel::valueOf('Q');
+        } elseif ($errorCorrectionLevel instanceof ErrorCorrectionLevelHigh) {
+            return ErrorCorrectionLevel::valueOf('H');
+        }
+
+        throw new \Exception('Error correction level could not be converted');
+    }
+}

composer.json

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Endroid\QrCode\Bacon;
+
+use BaconQrCode\Encoder\Encoder;
+use Endroid\QrCode\Matrix\Matrix;
+use Endroid\QrCode\Matrix\MatrixFactoryInterface;
+use Endroid\QrCode\Matrix\MatrixInterface;
+use Endroid\QrCode\QrCodeInterface;
+
+final class MatrixFactory implements MatrixFactoryInterface
+{
+    public function create(QrCodeInterface $qrCode): MatrixInterface
+    {
+        $baconErrorCorrectionLevel = ErrorCorrectionLevelConverter::convertToBaconErrorCorrectionLevel($qrCode->getErrorCorrectionLevel());
+        $baconMatrix = Encoder::encode($qrCode->getData(), $baconErrorCorrectionLevel, strval($qrCode->getEncoding()))->getMatrix();
+
+        $blockValues = [];
+        $columnCount = $baconMatrix->getWidth();
+        $rowCount = $baconMatrix->getHeight();
+        for ($rowIndex = 0; $rowIndex < $rowCount; ++$rowIndex) {
+            $blockValues[$rowIndex] = [];
+            for ($columnIndex = 0; $columnIndex < $columnCount; ++$columnIndex) {
+                $blockValues[$rowIndex][$columnIndex] = $baconMatrix->get($columnIndex, $rowIndex);
+            }
+        }
+
+        return new Matrix($blockValues, $qrCode->getSize(), $qrCode->getMargin(), $qrCode->getRoundBlockSizeMode());
+    }
+}