[9.x] Cast Stringable to string when used with json_encode() (#35680)

crynobone · taylorotwell · antonkomarev · web-flow · commit 840166a046f6 · 2020-12-20T16:12:58.000-06:00
* [9.x] Cast Stringable to string when used with json_encode().

Signed-off-by: Mior Muhammad Zaki &lt;crynobone@gmail.com&gt;

* Update src/Illuminate/Support/Stringable.php

Co-authored-by: Anton Komarev &lt;1849174+antonkomarev@users.noreply.github.com&gt;

* Update Stringable.php

Co-authored-by: Taylor Otwell &lt;taylor@laravel.com&gt;
Co-authored-by: Anton Komarev &lt;1849174+antonkomarev@users.noreply.github.com&gt;
diff --git a/src/Illuminate/Support/Stringable.php b/src/Illuminate/Support/Stringable.php
@@ -4,9 +4,10 @@
 
 use Closure;
 use Illuminate\Support\Traits\Macroable;
+use JsonSerializable;
 use Symfony\Component\VarDumper\VarDumper;
 
-class Stringable
+class Stringable implements JsonSerializable
 {
     use Macroable;
 
@@ -722,6 +723,16 @@ public function dd()
         exit(1);
     }
 
+    /**
+     * Convert the object into something JSON serializable.
+     *
+     * @return string
+     */
+    public function jsonSerialize()
+    {
+        return $this->__toString();
+    }
+
     /**
      * Proxy dynamic properties onto methods.
      *
diff --git a/tests/Support/SupportStringableTest.php b/tests/Support/SupportStringableTest.php
@@ -545,4 +545,11 @@ public function testChunk()
         $this->assertInstanceOf(Collection::class, $chunks);
         $this->assertSame(['foo', 'bar', 'baz'], $chunks->all());
     }
+
+    public function testJsonSerializable()
+    {
+        $this->assertSame('"laravel-php-framework"', json_encode($this->stringable('LaravelPhpFramework')->kebab()));
+        $this->assertSame('["laravel-php-framework"]', json_encode([$this->stringable('LaravelPhpFramework')->kebab()]));
+        $this->assertSame('{"title":"laravel-php-framework"}', json_encode(['title' => $this->stringable('LaravelPhpFramework')->kebab()]));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -545,4 +545,11 @@ public function testChunk()`
`545`	`545`	`$this->assertInstanceOf(Collection::class, $chunks);`
`546`	`546`	`$this->assertSame(['foo', 'bar', 'baz'], $chunks->all());`
`547`	`547`	`}`
	`548`	`+`
	`549`	`+ public function testJsonSerializable()`
	`550`	`+ {`
	`551`	`+ $this->assertSame('"laravel-php-framework"', json_encode($this->stringable('LaravelPhpFramework')->kebab()));`
	`552`	`+ $this->assertSame('["laravel-php-framework"]', json_encode([$this->stringable('LaravelPhpFramework')->kebab()]));`
	`553`	`+ $this->assertSame('{"title":"laravel-php-framework"}', json_encode(['title' => $this->stringable('LaravelPhpFramework')->kebab()]));`
	`554`	`+ }`
`548`	`555`	`}`