Add options to JsonDecode and JsonEncode to wrap/unwrap json data

Add options to JsonDecode and JsonEncode to wrap/unwrap json data Add options to JsonDecode and JsonEncode to wrap/unwrap json data Add options to JsonDecode and JsonEncode to wrap/unwrap json data Add options to JsonDecode and JsonEncode to wrap/unwrap json data Add options to JsonDecode and JsonEncode to wrap/unwrap json data
symfony · nonanerz · Oct 16, 2018 · Oct 17, 2018 · Nov 11, 2018 · Nov 11, 2018
commit 1887e34ccbd8dc8542edcd9dd2f2b1ca837e3b6d
diff --git a/src/Symfony/Component/Serializer/Encoder/JsonDecode.php b/src/Symfony/Component/Serializer/Encoder/JsonDecode.php
@@ -42,7 +42,7 @@ public function __construct(bool $associative = false, int $depth = 512)
      *
      * @param string $data    The encoded JSON string to decode
      * @param string $format  Must be set to JsonEncoder::FORMAT
-     * @param array  $context An optional set of options for the JSON decoder; see below
+     * @param array  $context an optional set of options for the JSON decoder; see below
      *
      * The $context array is a simple key=>value array, with the following supported keys:
      *
@@ -58,6 +58,9 @@ public function __construct(bool $associative = false, int $depth = 512)
      * json_decode_options: integer
      *      Specifies additional options as per documentation for json_decode.
      *
+     * json_root_key: string
+     *      Specifies root key and allow to unwrap data
+     *
      * @return mixed
      *
      * @throws NotEncodableValueException
@@ -78,6 +81,16 @@ public function decode($data, $format, array $context = array())
             throw new NotEncodableValueException(json_last_error_msg());
         }
 
+        if ($rootKey = $context['json_root_key']) {
+            if (\is_array($decodedData) && array_key_exists($rootKey, $decodedData)) {
+                $decodedData = $decodedData[$rootKey];
+            } elseif (\is_object($decodedData) && property_exists($decodedData, $rootKey)) {
+                $decodedData = $decodedData->$rootKey;
+            } else {
+                $decodedData = null;
+            }
+        }
+
         return $decodedData;
     }
 
@@ -100,6 +113,7 @@ private function resolveContext(array $context)
             'json_decode_associative' => $this->associative,
             'json_decode_recursion_depth' => $this->recursionDepth,
             'json_decode_options' => 0,
+            'json_root_key' => null,
         );
 
         return array_merge($defaultOptions, $context);

diff --git a/src/Symfony/Component/Serializer/Encoder/JsonEncode.php b/src/Symfony/Component/Serializer/Encoder/JsonEncode.php
@@ -36,6 +36,10 @@ public function encode($data, $format, array $context = array())
     {
         $context = $this->resolveContext($context);
 
+        if (($rootKey = $context['json_root_key'])) {
+            $data = array($rootKey => $data);
+        }
+
         $encodedJson = json_encode($data, $context['json_encode_options']);
 
         if (JSON_ERROR_NONE !== json_last_error() && (false === $encodedJson || !($context['json_encode_options'] & JSON_PARTIAL_OUTPUT_ON_ERROR))) {
@@ -60,6 +64,6 @@ public function supportsEncoding($format)
      */
     private function resolveContext(array $context = array())
     {
-        return array_merge(array('json_encode_options' => $this->options), $context);
+        return array_merge(array('json_encode_options' => $this->options, 'json_root_key' => null), $context);
     }
 }
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/JsonDecodeTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/JsonDecodeTest.php
@@ -52,6 +52,8 @@ public function decodeProvider()
         return array(
             array('{"foo": "bar"}', $stdClass, array()),
             array('{"foo": "bar"}', $assoc, array('json_decode_associative' => true)),
+            array('{"baz": {"foo": "bar"}}', $stdClass, array('json_root_key' => 'baz')),
+            array('{"baz": {"foo": "bar"}}', $assoc, array('json_root_key' => 'baz', 'json_decode_associative' => true)),
         );
     }
 

diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/JsonEncodeTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/JsonEncodeTest.php
@@ -46,6 +46,7 @@ public function encodeProvider()
         return array(
             array(array(), '[]', array()),
             array(array(), '{}', array('json_encode_options' => JSON_FORCE_OBJECT)),
+            array(array('bar' => 'foo'), '{"baz":{"bar":"foo"}}', array('json_root_key' => 'baz')),
         );
     }