feat: make utf-8 eci prefix configurable (#130)

Bacon · Mar 19, 2024 · 1f3e1e9 · 1f3e1e9
1 parent c6f79a4
commit 1f3e1e9
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 4 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,8 +1,8 @@
 FROM php:8.1-cli
 
 COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
-RUN apt-get update && apt-get install -y libmagickwand-dev --no-install-recommends && rm -rf /var/lib/apt/lists/*
-RUN pecl install imagick && docker-php-ext-enable imagick
+RUN apt-get update && apt-get install -y libmagickwand-dev libzip-dev zip --no-install-recommends && rm -rf /var/lib/apt/lists/*
+RUN pecl install imagick && docker-php-ext-enable imagick && docker-php-ext-install zip
 RUN alias composer='php /usr/bin/composer'
 
 WORKDIR /app
diff --git a/src/Encoder/Encoder.php b/src/Encoder/Encoder.php
@@ -48,7 +48,9 @@ public static function encode(
         string $content,
         ErrorCorrectionLevel $ecLevel,
         string $encoding = self::DEFAULT_BYTE_MODE_ECODING,
-        ?Version $forcedVersion = null
+        ?Version $forcedVersion = null,
+        // Barcode scanner might not be able to read the encoded message of the QR code with the prefix ECI of UTF-8
+        bool $prefixEci = true
     ) : QrCode {
         // Pick an encoding mode appropriate for the content. Note that this
         // will not attempt to use multiple modes / segments even if that were
@@ -60,7 +62,7 @@ public static function encode(
         $headerBits = new BitArray();
 
         // Append ECI segment if applicable
-        if (Mode::BYTE() === $mode && self::DEFAULT_BYTE_MODE_ECODING !== $encoding) {
+        if ($prefixEci && Mode::BYTE() === $mode && self::DEFAULT_BYTE_MODE_ECODING !== $encoding) {
             $eci = CharacterSetEci::getCharacterSetEciByName($encoding);
 
             if (null !== $eci) {

diff --git a/test/Encoder/EncoderTest.php b/test/Encoder/EncoderTest.php
@@ -160,6 +160,41 @@ public function testSimpleUtf8Eci() : void
         $this->assertSame($expected, (string) $qrCode);
     }
 
+    public function testSimpleUtf8WithoutEci() : void
+    {
+        $qrCode = Encoder::encode('hello', ErrorCorrectionLevel::H(), 'utf-8', null, false);
+        $expected = "<<\n"
+            . " mode: BYTE\n"
+            . " ecLevel: H\n"
+            . " version: 1\n"
+            . " maskPattern: 6\n"
+            . " matrix:\n"
+            . " 1 1 1 1 1 1 1 0 0 0 0 0 1 0 1 1 1 1 1 1 1\n"
+            . " 1 0 0 0 0 0 1 0 0 0 0 0 0 0 1 0 0 0 0 0 1\n"
+            . " 1 0 1 1 1 0 1 0 1 1 0 1 0 0 1 0 1 1 1 0 1\n"
+            . " 1 0 1 1 1 0 1 0 1 0 1 0 0 0 1 0 1 1 1 0 1\n"
+            . " 1 0 1 1 1 0 1 0 0 0 1 1 1 0 1 0 1 1 1 0 1\n"
+            . " 1 0 0 0 0 0 1 0 0 0 1 0 0 0 1 0 0 0 0 0 1\n"
+            . " 1 1 1 1 1 1 1 0 1 0 1 0 1 0 1 1 1 1 1 1 1\n"
+            . " 0 0 0 0 0 0 0 0 0 1 1 1 0 0 0 0 0 0 0 0 0\n"
+            . " 0 0 0 1 1 0 1 1 0 1 1 1 0 0 0 0 0 1 1 0 0\n"
+            . " 1 0 1 0 0 1 0 1 0 1 1 0 0 0 1 1 1 1 1 0 0\n"
+            . " 1 1 0 1 0 1 1 0 1 1 0 1 0 1 0 1 0 0 1 1 1\n"
+            . " 1 1 0 0 1 1 0 1 0 1 0 0 1 1 0 1 1 0 1 0 0\n"
+            . " 0 1 0 0 1 1 1 1 1 0 0 0 0 0 1 1 1 1 0 1 0\n"
+            . " 0 0 0 0 0 0 0 0 1 0 1 0 1 1 1 0 0 1 0 1 0\n"
+            . " 1 1 1 1 1 1 1 0 1 0 1 0 0 0 1 0 0 0 1 0 0\n"
+            . " 1 0 0 0 0 0 1 0 0 1 1 1 0 1 0 0 0 1 1 1 1\n"
+            . " 1 0 1 1 1 0 1 0 1 0 1 0 1 0 0 0 1 1 0 1 1\n"
+            . " 1 0 1 1 1 0 1 0 1 0 1 1 1 1 0 0 1 0 0 0 0\n"
+            . " 1 0 1 1 1 0 1 0 0 0 1 1 0 1 1 1 1 1 1 1 1\n"
+            . " 1 0 0 0 0 0 1 0 0 1 1 1 1 1 1 1 1 1 1 1 1\n"
+            . " 1 1 1 1 1 1 1 0 0 0 1 0 0 1 0 0 0 0 0 0 0\n"
+            . ">>\n";
+
+        $this->assertSame($expected, (string) $qrCode);
+    }
+
     public function testAppendModeInfo() : void
     {
         $bits = new BitArray();