Add support to pretty-print JSON-output

Optionally add JSON_PRETTY_PRINT to json_encode-options.

Resolves: FluidTYPO3#1571

Author: neufeind

Classes/ViewHelpers/Format/Json/EncodeViewHelper.php

@@ -82,6 +82,13 @@ public function initializeArguments()
             'string',
             'A date() format for DateTime values to JSON-compatible values. NULL means JS UNIXTIME (time()*1000)'
         );
+        $this->registerArgument(
+            'prettyPrint',
+            'boolean',
+            'If TRUE the JSON-output will be in pretty-print',
+            false,
+            false
+        );
     }
 
     /**
@@ -97,8 +104,9 @@ public static function renderStatic(array $arguments, \Closure $renderChildrenCl
         $preventRecursion = (boolean) $arguments['preventRecursion'];
         $recursionMarker = $arguments['recursionMarker'];
         $dateTimeFormat = $arguments['dateTimeFormat'];
+        $prettyPrint = (boolean) $arguments['prettyPrint'];
         static::$encounteredClasses = [];
-        $json = static::encodeValue($value, $useTraversableKeys, $preventRecursion, $recursionMarker, $dateTimeFormat);
+        $json = static::encodeValue($value, $useTraversableKeys, $preventRecursion, $recursionMarker, $dateTimeFormat, $prettyPrint);
         return $json;
     }
 
@@ -108,10 +116,11 @@ public static function renderStatic(array $arguments, \Closure $renderChildrenCl
      * @param boolean $preventRecursion
      * @param string $recursionMarker
      * @param string $dateTimeFormat
+     * @param boolean $prettyPrint
      * @return string
      * @throws Exception
      */
-    protected static function encodeValue($value, $useTraversableKeys, $preventRecursion, $recursionMarker, $dateTimeFormat)
+    protected static function encodeValue($value, $useTraversableKeys, $preventRecursion, $recursionMarker, $dateTimeFormat, $prettyPrint)
     {
         if (true === $value instanceof \Traversable) {
             // Note: also converts ObjectStorage to \Vendor\Extname\Domain\Model\ObjectType[] which are each converted
@@ -128,7 +137,11 @@ protected static function encodeValue($value, $useTraversableKeys, $preventRecur
             $value = static::recursiveArrayOfDomainObjectsToArray($value, $preventRecursion, $recursionMarker);
             $value = static::recursiveDateTimeToUnixtimeMiliseconds($value, $dateTimeFormat);
         }
-        $json = json_encode($value, JSON_HEX_AMP | JSON_HEX_QUOT | JSON_HEX_APOS | JSON_HEX_TAG);
+        $encodeOptions = JSON_HEX_AMP | JSON_HEX_QUOT | JSON_HEX_APOS | JSON_HEX_TAG;
+        if ($prettyPrint) {
+            $encodeOptions |= JSON_PRETTY_PRINT;
+        }
+        $json = json_encode($value, $encodeOptions);
         if (JSON_ERROR_NONE !== json_last_error()) {
             ErrorUtility::throwViewHelperException('The provided argument cannot be converted into JSON.', 1358440181);
         }

Tests/Unit/ViewHelpers/Format/Json/EncodeViewHelperTest.php

@@ -35,7 +35,7 @@ public function encodesDateTime()
     {
         $dateTime = \DateTime::createFromFormat('U', 86400);
         $instance = $this->createInstance();
-        $test = $this->callInaccessibleMethod($instance, 'encodeValue', $dateTime, false, true, null, null);
+        $test = $this->callInaccessibleMethod($instance, 'encodeValue', $dateTime, false, true, null, null, false);
         $this->assertEquals(86400000, $test);
     }
 
@@ -48,7 +48,7 @@ public function encodesRecursiveDomainObject()
         $object = $this->getInstanceOfFoo();
         $object->setFoo($object);
         $instance = $this->createInstance();
-        $test = $this->callInaccessibleMethod($instance, 'encodeValue', $object, true, true, null, null);
+        $test = $this->callInaccessibleMethod($instance, 'encodeValue', $object, true, true, null, null, false);
         $this->assertEquals('{"bar":"baz","children":[],"foo":null,"name":null,"pid":null,"uid":null}', $test);
     }
 
@@ -75,7 +75,7 @@ public function encodesTraversable()
     {
         $traversable = $this->objectManager->get(ObjectStorage::class);
         $instance = $this->createInstance();
-        $test = $this->callInaccessibleMethod($instance, 'encodeValue', $traversable, false, true, null, null);
+        $test = $this->callInaccessibleMethod($instance, 'encodeValue', $traversable, false, true, null, null, false);
         $this->assertEquals('[]', $test);
     }