[12.x] Add toPrettyJson method (#56697)

* Add toPrettyJson method to collections

* Code style fixes

* Add toPrettyJson to Eloquent Model

* Add toPrettyJson to JsonResource

* Add toPrettyJson to CursorPaginator, LengthAwarePaginator and Paginator

* Add toPrettyJson to Fluent

* Add toPrettyJson to MessageBag

* formatting

* Fix issue for test

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: WendellAdriel

src/Illuminate/Collections/Enumerable.php

@@ -1269,6 +1269,13 @@ public function jsonSerialize(): mixed;
      */
     public function toJson($options = 0);
 
+    /**
+     * Get the collection of items as pretty print formatted JSON.
+     *
+     * @return string
+     */
+    public function toPrettyJson();
+
     /**
      * Get a CachingIterator instance.
      *

src/Illuminate/Collections/Traits/EnumeratesValues.php

@@ -984,6 +984,16 @@ public function toJson($options = 0)
         return json_encode($this->jsonSerialize(), $options);
     }
 
+    /**
+     * Get the collection of items as pretty print formatted JSON.
+     *
+     * @return string
+     */
+    public function toPrettyJson()
+    {
+        return $this->toJson(JSON_PRETTY_PRINT);
+    }
+
     /**
      * Get a CachingIterator instance.
      *

src/Illuminate/Database/Eloquent/Model.php

@@ -1800,6 +1800,18 @@ public function toJson($options = 0)
         return $json;
     }
 
+    /**
+     * Convert the model instance to pretty print formatted JSON.
+     *
+     * @return string
+     *
+     * @throws \Illuminate\Database\Eloquent\JsonEncodingException
+     */
+    public function toPrettyJson()
+    {
+        return $this->toJson(JSON_PRETTY_PRINT);
+    }
+
     /**
      * Convert the object into something JSON serializable.
      *

src/Illuminate/Http/Resources/Json/JsonResource.php

@@ -135,7 +135,7 @@ public function toArray(Request $request)
     }
 
     /**
-     * Convert the model instance to JSON.
+     * Convert the resource to JSON.
      *
      * @param  int  $options
      * @return string
@@ -153,6 +153,18 @@ public function toJson($options = 0)
         return $json;
     }
 
+    /**
+     * Convert the resource to pretty print formatted JSON.
+     *
+     * @return string
+     *
+     * @throws \Illuminate\Database\Eloquent\JsonEncodingException
+     */
+    public function toPrettyJson()
+    {
+        return $this->toJson(JSON_PRETTY_PRINT);
+    }
+
     /**
      * Get any additional data that should be returned with the resource array.
      *

src/Illuminate/Pagination/CursorPaginator.php

@@ -180,4 +180,14 @@ public function toJson($options = 0)
     {
         return json_encode($this->jsonSerialize(), $options);
     }
+
+    /**
+     * Convert the object to pretty print formatted JSON.
+     *
+     * @return string
+     */
+    public function toPrettyJson()
+    {
+        return $this->toJson(JSON_PRETTY_PRINT);
+    }
 }

src/Illuminate/Pagination/LengthAwarePaginator.php

@@ -242,4 +242,14 @@ public function toJson($options = 0)
     {
         return json_encode($this->jsonSerialize(), $options);
     }
+
+    /**
+     * Convert the object to pretty print formatted JSON.
+     *
+     * @return string
+     */
+    public function toPrettyJson()
+    {
+        return $this->toJson(JSON_PRETTY_PRINT);
+    }
 }

src/Illuminate/Pagination/Paginator.php

@@ -185,4 +185,14 @@ public function toJson($options = 0)
     {
         return json_encode($this->jsonSerialize(), $options);
     }
+
+    /**
+     * Convert the object to pretty print formatted JSON.
+     *
+     * @return string
+     */
+    public function toPrettyJson()
+    {
+        return $this->toJson(JSON_PRETTY_PRINT);
+    }
 }

src/Illuminate/Support/Fluent.php

@@ -203,6 +203,16 @@ public function toJson($options = 0)
         return json_encode($this->jsonSerialize(), $options);
     }
 
+    /**
+     * Convert the fluent instance to pretty print formatted JSON.
+     *
+     * @return string
+     */
+    public function toPrettyJson()
+    {
+        return $this->toJson(JSON_PRETTY_PRINT);
+    }
+
     /**
      * Determine if the fluent instance is empty.
      *

src/Illuminate/Support/MessageBag.php

@@ -431,6 +431,16 @@ public function toJson($options = 0)
         return json_encode($this->jsonSerialize(), $options);
     }
 
+    /**
+     * Convert the object to pretty print formatted JSON.
+     *
+     * @return string
+     */
+    public function toPrettyJson()
+    {
+        return $this->toJson(JSON_PRETTY_PRINT);
+    }
+
     /**
      * Convert the message bag to its string representation.
      *

tests/Database/DatabaseEloquentModelTest.php

@@ -3414,6 +3414,18 @@ public function testModelToJsonSucceedsWithPriorErrors(): void
         $this->assertSame('{"name":"Mateus"}', $user->toJson(JSON_THROW_ON_ERROR));
     }
 
+    public function testModelToPrettyJson(): void
+    {
+        $user = new EloquentModelStub(['name' => 'Mateus', 'active' => true]);
+        $results = $user->toPrettyJson();
+        $expected = $user->toJson(JSON_PRETTY_PRINT);
+
+        $this->assertJsonStringEqualsJsonString($expected, $results);
+        $this->assertSame($expected, $results);
+        $this->assertStringContainsString("\n", $results);
+        $this->assertStringContainsString('    ', $results);
+    }
+
     public function testFillableWithMutators()
     {
         $model = new EloquentModelWithMutators;