[HttpFoundation] Fix BC break introduced by symfony#17642

dunglas · dunglas · commit f54f7d239f59 · 2016-03-04T08:27:22.000+01:00
diff --git a/src/Symfony/Component/HttpFoundation/JsonResponse.php b/src/Symfony/Component/HttpFoundation/JsonResponse.php
@@ -39,17 +39,17 @@ class JsonResponse extends Response
      * @param mixed $data       The response data
      * @param int   $status     The response status code
      * @param array $headers    An array of response headers
-     * @param bool  $preEncoded If the data is already a JSON string
+     * @param bool  $json       If the data is already a JSON string
      */
-    public function __construct($data = null, $status = 200, $headers = array(), $preEncoded = false)
+    public function __construct($data = null, $status = 200, $headers = array(), $json = false)
     {
         parent::__construct('', $status, $headers);
 
         if (null === $data) {
             $data = new \ArrayObject();
         }
 
-        $this->setData($data, $preEncoded);
+        $json ? $this->setJson($data) : $this->setData($data);
     }
 
     /**
@@ -87,46 +87,57 @@ public function setCallback($callback = null)
         return $this->update();
     }
 
+    /**
+     * Sets a raw string containing a JSON document to be sent.
+     *
+     * @param string $data
+     *
+     * @return JsonResponse
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function setJson($json)
+    {
+        $this->data = $json;
+
+        return $this->update();
+    }
+
     /**
      * Sets the data to be sent as JSON.
      *
      * @param mixed $data
-     * @param bool  $preEncoded If the data is already a JSON string
      *
      * @return JsonResponse
      *
      * @throws \InvalidArgumentException
      */
-    public function setData($data = array(), $preEncoded = false)
+    public function setData($data = array())
     {
-        if (!$preEncoded) {
-            if (defined('HHVM_VERSION')) {
-                // HHVM does not trigger any warnings and let exceptions
-                // thrown from a JsonSerializable object pass through.
-                // If only PHP did the same...
+        if (defined('HHVM_VERSION')) {
+            // HHVM does not trigger any warnings and let exceptions
+            // thrown from a JsonSerializable object pass through.
+            // If only PHP did the same...
+            $data = json_encode($data, $this->encodingOptions);
+        } else {
+            try {
+                // PHP 5.4 and up wrap exceptions thrown by JsonSerializable
+                // objects in a new exception that needs to be removed.
+                // Fortunately, PHP 5.5 and up do not trigger any warning anymore.
                 $data = json_encode($data, $this->encodingOptions);
-            } else {
-                try {
-                    // PHP 5.4 and up wrap exceptions thrown by JsonSerializable
-                    // objects in a new exception that needs to be removed.
-                    // Fortunately, PHP 5.5 and up do not trigger any warning anymore.
-                    $data = json_encode($data, $this->encodingOptions);
-                } catch (\Exception $e) {
-                    if ('Exception' === get_class($e) && 0 === strpos($e->getMessage(), 'Failed calling ')) {
-                        throw $e->getPrevious() ?: $e;
-                    }
-                    throw $e;
+            } catch (\Exception $e) {
+                if ('Exception' === get_class($e) && 0 === strpos($e->getMessage(), 'Failed calling ')) {
+                    throw $e->getPrevious() ?: $e;
                 }
-            }
-
-            if (JSON_ERROR_NONE !== json_last_error()) {
-                throw new \InvalidArgumentException(json_last_error_msg());
+                throw $e;
             }
         }
 
-        $this->data = $data;
+        if (JSON_ERROR_NONE !== json_last_error()) {
+            throw new \InvalidArgumentException(json_last_error_msg());
+        }
 
-        return $this->update();
+        return $this->setJson($data);
     }
 
     /**
diff --git a/src/Symfony/Component/HttpFoundation/Tests/JsonResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/JsonResponseTest.php
@@ -75,15 +75,16 @@ public function testConstructorWithCustomContentType()
         $this->assertSame('application/vnd.acme.blog-v1+json', $response->headers->get('Content-Type'));
     }
 
-    public function testConstructorWithPreEncoded()
+    public function testSetJson()
     {
         $response = new JsonResponse('1', 200, array(), true);
         $this->assertEquals('1', $response->getContent());
 
         $response = new JsonResponse('[1]', 200, array(), true);
         $this->assertEquals('[1]', $response->getContent());
 
-        $response = new JsonResponse('true', 200, array(), true);
+        $response = new JsonResponse(null, 200, array());
+        $response->setJson('true');
         $this->assertEquals('true', $response->getContent());
     }
 

Original file line number	Diff line number	Diff line change
`@@ -75,15 +75,16 @@ public function testConstructorWithCustomContentType()`
`75`	`75`	`$this->assertSame('application/vnd.acme.blog-v1+json', $response->headers->get('Content-Type'));`
`76`	`76`	`}`
`77`	`77`
`78`		`- public function testConstructorWithPreEncoded()`
	`78`	`+ public function testSetJson()`
`79`	`79`	`{`
`80`	`80`	`$response = new JsonResponse('1', 200, array(), true);`
`81`	`81`	`$this->assertEquals('1', $response->getContent());`
`82`	`82`
`83`	`83`	`$response = new JsonResponse('[1]', 200, array(), true);`
`84`	`84`	`$this->assertEquals('[1]', $response->getContent());`
`85`	`85`
`86`		`- $response = new JsonResponse('true', 200, array(), true);`
	`86`	`+ $response = new JsonResponse(null, 200, array());`
	`87`	`+ $response->setJson('true');`
`87`	`88`	`$this->assertEquals('true', $response->getContent());`
`88`	`89`	`}`
`89`	`90`