Let toPrettyJson() accepts options (#56876)

lucasmichot · web-flow · commit 185d9bbfe0e8 · 2025-09-02T10:31:06.000-05:00
diff --git a/src/Illuminate/Collections/Enumerable.php b/src/Illuminate/Collections/Enumerable.php
@@ -1272,9 +1272,11 @@ public function toJson($options = 0);
     /**
      * Get the collection of items as pretty print formatted JSON.
      *
+     *
+     * @param  int  $options
      * @return string
      */
-    public function toPrettyJson();
+    public function toPrettyJson(int $options = 0);
 
     /**
      * Get a CachingIterator instance.
diff --git a/src/Illuminate/Collections/Traits/EnumeratesValues.php b/src/Illuminate/Collections/Traits/EnumeratesValues.php
@@ -987,11 +987,12 @@ public function toJson($options = 0)
     /**
      * Get the collection of items as pretty print formatted JSON.
      *
+     * @param  int  $options
      * @return string
      */
-    public function toPrettyJson()
+    public function toPrettyJson(int $options = 0)
     {
-        return $this->toJson(JSON_PRETTY_PRINT);
+        return $this->toJson(JSON_PRETTY_PRINT | $options);
     }
 
     /**
diff --git a/src/Illuminate/Database/Eloquent/Model.php b/src/Illuminate/Database/Eloquent/Model.php
@@ -1803,13 +1803,14 @@ public function toJson($options = 0)
     /**
      * Convert the model instance to pretty print formatted JSON.
      *
+     * @param  int  $options
      * @return string
      *
      * @throws \Illuminate\Database\Eloquent\JsonEncodingException
      */
-    public function toPrettyJson()
+    public function toPrettyJson(int $options = 0)
     {
-        return $this->toJson(JSON_PRETTY_PRINT);
+        return $this->toJson(JSON_PRETTY_PRINT | $options);
     }
 
     /**
diff --git a/src/Illuminate/Http/Resources/Json/JsonResource.php b/src/Illuminate/Http/Resources/Json/JsonResource.php
@@ -163,13 +163,14 @@ public function toJson($options = 0)
     /**
      * Convert the resource to pretty print formatted JSON.
      *
+     * @param  int  $options
      * @return string
      *
      * @throws \Illuminate\Database\Eloquent\JsonEncodingException
      */
-    public function toPrettyJson()
+    public function toPrettyJson(int $options = 0)
     {
-        return $this->toJson(JSON_PRETTY_PRINT);
+        return $this->toJson(JSON_PRETTY_PRINT | $options);
     }
 
     /**
diff --git a/src/Illuminate/Pagination/CursorPaginator.php b/src/Illuminate/Pagination/CursorPaginator.php
@@ -184,10 +184,12 @@ public function toJson($options = 0)
     /**
      * Convert the object to pretty print formatted JSON.
      *
+     * @params int $options
+     *
      * @return string
      */
-    public function toPrettyJson()
+    public function toPrettyJson(int $options = 0)
     {
-        return $this->toJson(JSON_PRETTY_PRINT);
+        return $this->toJson(JSON_PRETTY_PRINT | $options);
     }
 }
diff --git a/src/Illuminate/Pagination/LengthAwarePaginator.php b/src/Illuminate/Pagination/LengthAwarePaginator.php
@@ -246,10 +246,12 @@ public function toJson($options = 0)
     /**
      * Convert the object to pretty print formatted JSON.
      *
+     * @params int $options
+     *
      * @return string
      */
-    public function toPrettyJson()
+    public function toPrettyJson(int $options = 0)
     {
-        return $this->toJson(JSON_PRETTY_PRINT);
+        return $this->toJson(JSON_PRETTY_PRINT | $options);
     }
 }
diff --git a/src/Illuminate/Pagination/Paginator.php b/src/Illuminate/Pagination/Paginator.php
@@ -189,10 +189,12 @@ public function toJson($options = 0)
     /**
      * Convert the object to pretty print formatted JSON.
      *
+     * @params int $options
+     *
      * @return string
      */
-    public function toPrettyJson()
+    public function toPrettyJson(int $options = 0)
     {
-        return $this->toJson(JSON_PRETTY_PRINT);
+        return $this->toJson(JSON_PRETTY_PRINT | $options);
     }
 }
diff --git a/src/Illuminate/Support/Fluent.php b/src/Illuminate/Support/Fluent.php
@@ -206,11 +206,13 @@ public function toJson($options = 0)
     /**
      * Convert the fluent instance to pretty print formatted JSON.
      *
+     * @params int $options
+     *
      * @return string
      */
-    public function toPrettyJson()
+    public function toPrettyJson(int $options = 0)
     {
-        return $this->toJson(JSON_PRETTY_PRINT);
+        return $this->toJson(JSON_PRETTY_PRINT | $options);
     }
 
     /**
diff --git a/src/Illuminate/Support/MessageBag.php b/src/Illuminate/Support/MessageBag.php
@@ -434,11 +434,13 @@ public function toJson($options = 0)
     /**
      * Convert the object to pretty print formatted JSON.
      *
+     * @params int $options
+     *
      * @return string
      */
-    public function toPrettyJson()
+    public function toPrettyJson(int $options = 0)
     {
-        return $this->toJson(JSON_PRETTY_PRINT);
+        return $this->toJson(JSON_PRETTY_PRINT | $options);
     }
 
     /**
diff --git a/tests/Database/DatabaseEloquentModelTest.php b/tests/Database/DatabaseEloquentModelTest.php
@@ -3448,14 +3448,19 @@ public function testModelToJsonSucceedsWithPriorErrors(): void
 
     public function testModelToPrettyJson(): void
     {
-        $user = new EloquentModelStub(['name' => 'Mateus', 'active' => true]);
+        $user = new EloquentModelStub(['name' => 'Mateus', 'active' => true, 'number' => '123']);
         $results = $user->toPrettyJson();
         $expected = $user->toJson(JSON_PRETTY_PRINT);
 
         $this->assertJsonStringEqualsJsonString($expected, $results);
         $this->assertSame($expected, $results);
         $this->assertStringContainsString("\n", $results);
         $this->assertStringContainsString('    ', $results);
+
+        $results = $user->toPrettyJson(JSON_NUMERIC_CHECK);
+        $this->assertStringContainsString("\n", $results);
+        $this->assertStringContainsString('    ', $results);
+        $this->assertStringContainsString('"number": 123', $results);
     }
 
     public function testFillableWithMutators()
diff --git a/tests/Http/JsonResourceTest.php b/tests/Http/JsonResourceTest.php
@@ -54,7 +54,7 @@ public function testJsonResourceToPrettyPrint(): void
 
         $resource = m::mock(JsonResource::class, ['resource' => $model])
             ->makePartial()
-            ->shouldReceive('jsonSerialize')->andReturn(['foo' => 'bar', 'bar' => 'foo'])
+            ->shouldReceive('jsonSerialize')->andReturn(['foo' => 'bar', 'bar' => 'foo', 'number' => 123])
             ->getMock();
 
         $results = $resource->toPrettyJson();
@@ -64,5 +64,10 @@ public function testJsonResourceToPrettyPrint(): void
         $this->assertSame($expected, $results);
         $this->assertStringContainsString("\n", $results);
         $this->assertStringContainsString('    ', $results);
+
+        $results = $resource->toPrettyJson(JSON_NUMERIC_CHECK);
+        $this->assertStringContainsString("\n", $results);
+        $this->assertStringContainsString('    ', $results);
+        $this->assertStringContainsString('"number": 123', $results);
     }
 }
diff --git a/tests/Pagination/CursorPaginatorTest.php b/tests/Pagination/CursorPaginatorTest.php
@@ -132,14 +132,19 @@ public function testCursorPaginatorToJson()
 
     public function testCursorPaginatorToPrettyJson()
     {
-        $paginator = new CursorPaginator([['id' => 1], ['id' => 2], ['id' => 3], ['id' => 4]], 2, null);
+        $paginator = new CursorPaginator([['id' => '1'], ['id' => '2'], ['id' => '3'], ['id' => '4']], 2, null);
         $results = $paginator->toPrettyJson();
         $expected = $paginator->toJson(JSON_PRETTY_PRINT);
 
         $this->assertJsonStringEqualsJsonString($expected, $results);
         $this->assertSame($expected, $results);
         $this->assertStringContainsString("\n", $results);
         $this->assertStringContainsString('    ', $results);
+
+        $results = $paginator->toPrettyJson(JSON_NUMERIC_CHECK);
+        $this->assertStringContainsString("\n", $results);
+        $this->assertStringContainsString('    ', $results);
+        $this->assertStringContainsString('"id": 1', $results);
     }
 
     protected function getCursor($params, $isNext = true)
diff --git a/tests/Pagination/PaginatorTest.php b/tests/Pagination/PaginatorTest.php
@@ -85,13 +85,19 @@ public function testPaginatorToJson()
 
     public function testPaginatorToPrettyJson()
     {
-        $p = new Paginator(['item1', 'item2', 'item3'], 3, 1);
+        $p = new Paginator(['item/1', 'item/2', 'item/3'], 3, 1);
         $results = $p->toPrettyJson();
         $expected = $p->toJson(JSON_PRETTY_PRINT);
 
         $this->assertJsonStringEqualsJsonString($expected, $results);
         $this->assertSame($expected, $results);
         $this->assertStringContainsString("\n", $results);
         $this->assertStringContainsString('    ', $results);
+        $this->assertStringContainsString('item\/1', $results);
+
+        $results = $p->toPrettyJson(JSON_UNESCAPED_SLASHES);
+        $this->assertStringContainsString("\n", $results);
+        $this->assertStringContainsString('    ', $results);
+        $this->assertStringContainsString('item/1', $results);
     }
 }
diff --git a/tests/Support/SupportMessageBagTest.php b/tests/Support/SupportMessageBagTest.php
@@ -261,13 +261,21 @@ public function testMessageBagReturnsExpectedPrettyJson()
         $container->setFormat(':message');
         $container->add('foo', 'bar');
         $container->add('boom', 'baz');
+        $container->add('baz', '123');
         $results = $container->toPrettyJson();
         $expected = $container->toJson(JSON_PRETTY_PRINT);
 
         $this->assertJsonStringEqualsJsonString($expected, $results);
         $this->assertSame($expected, $results);
         $this->assertStringContainsString("\n", $results);
         $this->assertStringContainsString('    ', $results);
+        $this->assertStringContainsString('"123"', $results);
+
+        $results = $container->toPrettyJson(JSON_NUMERIC_CHECK);
+        $this->assertStringContainsString("\n", $results);
+        $this->assertStringContainsString('    ', $results);
+        $this->assertStringContainsString('123', $results);
+        $this->assertStringNotContainsString('"123"', $results);
     }
 
     public function testCountReturnsCorrectValue()

Original file line number	Diff line number	Diff line change
`@@ -987,11 +987,12 @@ public function toJson($options = 0)`
`987`	`987`	`/**`
`988`	`988`	`* Get the collection of items as pretty print formatted JSON.`
`989`	`989`	`*`
	`990`	`+ * @param int $options`
`990`	`991`	`* @return string`
`991`	`992`	`*/`
`992`		`- public function toPrettyJson()`
	`993`	`+ public function toPrettyJson(int $options = 0)`
`993`	`994`	`{`
`994`		`- return $this->toJson(JSON_PRETTY_PRINT);`
	`995`	`+ return $this->toJson(JSON_PRETTY_PRINT \| $options);`
`995`	`996`	`}`
`996`	`997`
`997`	`998`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -1803,13 +1803,14 @@ public function toJson($options = 0)`
`1803`	`1803`	`/**`
`1804`	`1804`	`* Convert the model instance to pretty print formatted JSON.`
`1805`	`1805`	`*`
	`1806`	`+ * @param int $options`
`1806`	`1807`	`* @return string`
`1807`	`1808`	`*`
`1808`	`1809`	`* @throws \Illuminate\Database\Eloquent\JsonEncodingException`
`1809`	`1810`	`*/`
`1810`		`- public function toPrettyJson()`
	`1811`	`+ public function toPrettyJson(int $options = 0)`
`1811`	`1812`	`{`
`1812`		`- return $this->toJson(JSON_PRETTY_PRINT);`
	`1813`	`+ return $this->toJson(JSON_PRETTY_PRINT \| $options);`
`1813`	`1814`	`}`
`1814`	`1815`
`1815`	`1816`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -163,13 +163,14 @@ public function toJson($options = 0)`
`163`	`163`	`/**`
`164`	`164`	`* Convert the resource to pretty print formatted JSON.`
`165`	`165`	`*`
	`166`	`+ * @param int $options`
`166`	`167`	`* @return string`
`167`	`168`	`*`
`168`	`169`	`* @throws \Illuminate\Database\Eloquent\JsonEncodingException`
`169`	`170`	`*/`
`170`		`- public function toPrettyJson()`
	`171`	`+ public function toPrettyJson(int $options = 0)`
`171`	`172`	`{`
`172`		`- return $this->toJson(JSON_PRETTY_PRINT);`
	`173`	`+ return $this->toJson(JSON_PRETTY_PRINT \| $options);`
`173`	`174`	`}`
`174`	`175`
`175`	`176`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -184,10 +184,12 @@ public function toJson($options = 0)`
`184`	`184`	`/**`
`185`	`185`	`* Convert the object to pretty print formatted JSON.`
`186`	`186`	`*`
	`187`	`+ * @params int $options`
	`188`	`+ *`
`187`	`189`	`* @return string`
`188`	`190`	`*/`
`189`		`- public function toPrettyJson()`
	`191`	`+ public function toPrettyJson(int $options = 0)`
`190`	`192`	`{`
`191`		`- return $this->toJson(JSON_PRETTY_PRINT);`
	`193`	`+ return $this->toJson(JSON_PRETTY_PRINT \| $options);`
`192`	`194`	`}`
`193`	`195`	`}`
Original file line number	Diff line number	Diff line change
`@@ -246,10 +246,12 @@ public function toJson($options = 0)`
`246`	`246`	`/**`
`247`	`247`	`* Convert the object to pretty print formatted JSON.`
`248`	`248`	`*`
	`249`	`+ * @params int $options`
	`250`	`+ *`
`249`	`251`	`* @return string`
`250`	`252`	`*/`
`251`		`- public function toPrettyJson()`
	`253`	`+ public function toPrettyJson(int $options = 0)`
`252`	`254`	`{`
`253`		`- return $this->toJson(JSON_PRETTY_PRINT);`
	`255`	`+ return $this->toJson(JSON_PRETTY_PRINT \| $options);`
`254`	`256`	`}`
`255`	`257`	`}`
Original file line number	Diff line number	Diff line change
`@@ -189,10 +189,12 @@ public function toJson($options = 0)`
`189`	`189`	`/**`
`190`	`190`	`* Convert the object to pretty print formatted JSON.`
`191`	`191`	`*`
	`192`	`+ * @params int $options`
	`193`	`+ *`
`192`	`194`	`* @return string`
`193`	`195`	`*/`
`194`		`- public function toPrettyJson()`
	`196`	`+ public function toPrettyJson(int $options = 0)`
`195`	`197`	`{`
`196`		`- return $this->toJson(JSON_PRETTY_PRINT);`
	`198`	`+ return $this->toJson(JSON_PRETTY_PRINT \| $options);`
`197`	`199`	`}`
`198`	`200`	`}`
Original file line number	Diff line number	Diff line change
`@@ -206,11 +206,13 @@ public function toJson($options = 0)`
`206`	`206`	`/**`
`207`	`207`	`* Convert the fluent instance to pretty print formatted JSON.`
`208`	`208`	`*`
	`209`	`+ * @params int $options`
	`210`	`+ *`
`209`	`211`	`* @return string`
`210`	`212`	`*/`
`211`		`- public function toPrettyJson()`
	`213`	`+ public function toPrettyJson(int $options = 0)`
`212`	`214`	`{`
`213`		`- return $this->toJson(JSON_PRETTY_PRINT);`
	`215`	`+ return $this->toJson(JSON_PRETTY_PRINT \| $options);`
`214`	`216`	`}`
`215`	`217`
`216`	`218`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -434,11 +434,13 @@ public function toJson($options = 0)`
`434`	`434`	`/**`
`435`	`435`	`* Convert the object to pretty print formatted JSON.`
`436`	`436`	`*`
	`437`	`+ * @params int $options`
	`438`	`+ *`
`437`	`439`	`* @return string`
`438`	`440`	`*/`
`439`		`- public function toPrettyJson()`
	`441`	`+ public function toPrettyJson(int $options = 0)`
`440`	`442`	`{`
`441`		`- return $this->toJson(JSON_PRETTY_PRINT);`
	`443`	`+ return $this->toJson(JSON_PRETTY_PRINT \| $options);`
`442`	`444`	`}`
`443`	`445`
`444`	`446`	`/**`