feat(support): support base64 in json encode and decode

Author: innocenzi

packages/support/src/Json/functions.php

@@ -21,8 +21,16 @@
  *
  * @throws Exception\JsonCouldNotBeDecoded If an error occurred.
  */
-function decode(string $json, bool $associative = true): mixed
+function decode(string $json, bool $associative = true, bool $base64 = false): mixed
 {
+    if ($base64) {
+        $json = base64_decode($json, strict: true);
+
+        if ($json === false) {
+            throw new Exception\JsonCouldNotBeDecoded('The provided base64 string is not valid.');
+        }
+    }
+
     try {
         /** @var mixed $value */
         $value = json_decode($json, $associative, 512, JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR);
@@ -40,7 +48,7 @@ function decode(string $json, bool $associative = true): mixed
  *
  * @return non-empty-string
  */
-function encode(mixed $value, bool $pretty = false, int $flags = 0): string
+function encode(mixed $value, bool $pretty = false, int $flags = 0, bool $base64 = false): string
 {
     $flags |= JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_PRESERVE_ZERO_FRACTION | JSON_THROW_ON_ERROR;
 
@@ -55,6 +63,10 @@ function encode(mixed $value, bool $pretty = false, int $flags = 0): string
         throw new Exception\JsonCouldNotBeEncoded(sprintf('%s.', $jsonException->getMessage()), $jsonException->getCode(), $jsonException);
     }
 
+    if ($base64) {
+        return base64_encode($json);
+    }
+
     return $json;
 }
 

packages/support/tests/Json/JsonTest.php

@@ -121,4 +121,28 @@ public function test_is_valid(): void
         $this->assertFalse(Json\is_valid(['foo' => 'bar']));
         $this->assertFalse(Json\is_valid(1));
     }
+
+    public function test_base64_encode_and_decode(): void
+    {
+        $data = [
+            'name' => 'azjezz/psl',
+            'type' => 'library',
+            'description' => 'PHP Standard Library.',
+            'keywords' => ['php', 'std', 'stdlib', 'utility', 'psl'],
+            'license' => 'MIT',
+        ];
+
+        $encoded = Json\encode($data, base64: true);
+        $decoded = Json\decode($encoded, base64: true);
+
+        $this->assertSame($data, $decoded);
+    }
+
+    public function test_base64_decode_failure(): void
+    {
+        $this->expectException(Json\Exception\JsonCouldNotBeDecoded::class);
+        $this->expectExceptionMessage('The provided base64 string is not valid.');
+
+        Json\decode('invalid_base64', base64: true);
+    }
 }