Add support for BOM-signed env files (#501)

vlucas · Nov 10, 2021 · d4394d0 · d4394d0
1 parent 7261bb0
commit d4394d0
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/src/Util/Str.php b/src/Util/Str.php
@@ -41,11 +41,19 @@ public static function utf8(string $input, string $encoding = null)
                 \sprintf('Illegal character encoding [%s] specified.', $encoding)
             );
         }
-
+        $converted = $encoding === null ?
+            @\mb_convert_encoding($input, 'UTF-8') :
+            @\mb_convert_encoding($input, 'UTF-8', $encoding);
+        /**
+         * this is for support UTF-8 with BOM encoding
+         * @see https://en.wikipedia.org/wiki/Byte_order_mark
+         * @see https://github.com/vlucas/phpdotenv/issues/500
+         */
+        if (\substr($converted, 0, 3) == "\xEF\xBB\xBF") {
+            $converted = \substr($converted, 3);
+        }
         /** @var \GrahamCampbell\ResultType\Result<string,string> */
-        return Success::create(
-            $encoding === null ? @\mb_convert_encoding($input, 'UTF-8') : @\mb_convert_encoding($input, 'UTF-8', $encoding)
-        );
+        return Success::create($converted);
     }
 
     /**

diff --git a/tests/Dotenv/Store/StoreTest.php b/tests/Dotenv/Store/StoreTest.php
@@ -127,4 +127,15 @@ public function testFileReadMultipleWithoutShortCircuitMode()
             $builder->make()->read()
         );
     }
+    public function testFileReadWithUtf8WithBomEncoding()
+    {
+        self::assertSame(
+            [
+                self::$folder.\DIRECTORY_SEPARATOR.'utf8-with-bom-encoding.env' => "FOO=bar\nBAR=baz\nSPACED=\"with spaces\"\n",
+            ],
+            Reader::read(
+                Paths::filePaths([self::$folder], ['utf8-with-bom-encoding.env'])
+            )
+        );
+    }
 }
diff --git a/tests/fixtures/env/utf8-with-bom-encoding.env b/tests/fixtures/env/utf8-with-bom-encoding.env
@@ -0,0 +1,3 @@
+FOO=bar
+BAR=baz
+SPACED="with spaces"