Add Client/Response::getStringBody().

Deprecate Client/Response::body().
cakephp · Nov 21, 2018 · af446e8 · af446e8
1 parent 2f56d07
commit af446e8
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 16 deletions.
diff --git a/src/Http/Client/Response.php b/src/Http/Client/Response.php
@@ -55,7 +55,7 @@
  * You can get the body string using:
  *
  * ```
- * $content = $response->getBody()->getContents();
+ * $content = $response->getStringBody();
  * ```
  *
  * If your response body is in XML or JSON you can use
@@ -141,7 +141,7 @@ class Response extends Message implements ResponseInterface
      */
     protected $_deprecatedMagicProperties = [
         'cookies' => 'getCookies()',
-        'body' => 'getBody()->getContents()',
+        'body' => 'getStringBody()',
         'json' => 'getJson()',
         'xml' => 'getXml()',
         'headers' => 'getHeaders()',
@@ -556,9 +556,14 @@ public function version()
      * @param callable|null $parser The callback to use to decode
      *   the response body.
      * @return mixed The response body.
+     * @deprecated 3.7.0 Use getStringBody()/getJson()/getXml() instead.
      */
     public function body($parser = null)
     {
+        deprecationWarning(
+            'Response::body() is deprecated. Use getStringBody()/getJson()/getXml() instead.'
+        );
+
         $stream = $this->stream;
         $stream->rewind();
         if ($parser) {
@@ -568,6 +573,16 @@ public function body($parser = null)
         return $stream->getContents();
     }
 
+    /**
+     * Get the response body as string.
+     *
+     * @return string
+     */
+    public function getStringBody()
+    {
+        return $this->_getBody();
+    }
+
     /**
      * Get the response body as JSON decoded data.
      *
@@ -641,7 +656,7 @@ protected function _getHeaders()
     /**
      * Provides magic __get() support.
      *
-     * @return array
+     * @return string
      */
     protected function _getBody()
     {

diff --git a/tests/TestCase/Http/Client/Adapter/StreamTest.php b/tests/TestCase/Http/Client/Adapter/StreamTest.php
@@ -152,7 +152,7 @@ public function testSendByUsingCakephpProtocol()
         $responses = $stream->send($request, []);
         $this->assertInstanceOf('Cake\Http\Client\Response', $responses[0]);
 
-        $this->assertEquals(20000, strlen($responses[0]->body()));
+        $this->assertEquals(20000, strlen($responses[0]->getStringBody()));
     }
 
     /**

diff --git a/tests/TestCase/Http/Client/ResponseTest.php b/tests/TestCase/Http/Client/ResponseTest.php
@@ -96,21 +96,35 @@ public function testHeaderParsing()
      */
     public function testBody()
     {
-        $data = [
-            'property' => 'value'
-        ];
-        $encoded = json_encode($data);
+        $this->deprecated(function () {
+            $data = [
+                'property' => 'value'
+            ];
+            $encoded = json_encode($data);
 
-        $response = new Response([], $encoded);
+            $response = new Response([], $encoded);
+
+            $this->assertEquals($encoded, $response->getBody()->getContents());
+            $this->assertEquals($encoded, $response->body());
 
-        $this->assertEquals($encoded, $response->getBody()->getContents());
-        $this->assertEquals($encoded, $response->body());
+            $result = $response->body('json_decode');
+            $this->assertEquals($data['property'], $result->property);
+            $stream = $response->getBody();
+            $stream->rewind();
+            $this->assertEquals($encoded, $stream->getContents());
+        });
+    }
+
+    /**
+     * Test getStringBody()
+     *
+     * @return void
+     */
+    public function getStringBody()
+    {
+        $response = new Response([], 'string');
 
-        $result = $response->body('json_decode');
-        $this->assertEquals($data['property'], $result->property);
-        $stream = $response->getBody();
-        $stream->rewind();
-        $this->assertEquals($encoded, $stream->getContents());
+        $this->assertEquals('string', $response->getStringBody());
     }
 
     /**