[BrowserKit] deprecated Response::getStatus() in favor of Response::getStatusCode()

fabpot · fabpot · commit e8e52355d49f · 2019-01-14T16:15:59.000+01:00
diff --git a/UPGRADE-4.3.md b/UPGRADE-4.3.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 4.2 to 4.3
 =======================
 
+BrowserKit
+----------
+
+ * Deprecated `Response::getStatus()`, use `Response::getStatusCode()` instead
+
 Config
 ------
 
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -4,6 +4,7 @@ UPGRADE FROM 4.x to 5.0
 BrowserKit
 ----------
 
+ * Removed `Response::getStatus()`, use `Response::getStatusCode()` instead
  * The `Client::submit()` method has a new `$serverParameters` argument.
 
 Cache
diff --git a/src/Symfony/Component/BrowserKit/CHANGELOG.md b/src/Symfony/Component/BrowserKit/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.3.0
+-----
+
+ * Deprecated `Response::getStatus()`, use `Response::getStatusCode()` instead
+
 4.2.0
 -----
 
diff --git a/src/Symfony/Component/BrowserKit/Client.php b/src/Symfony/Component/BrowserKit/Client.php
@@ -409,7 +409,7 @@ public function request(string $method, string $uri, array $parameters = array()
 
         $this->cookieJar->updateFromResponse($this->internalResponse, $uri);
 
-        $status = $this->internalResponse->getStatus();
+        $status = $this->internalResponse->getStatusCode();
 
         if ($status >= 300 && $status < 400) {
             $this->redirect = $this->internalResponse->getHeader('Location');
@@ -599,7 +599,7 @@ public function followRedirect()
 
         $request = $this->internalRequest;
 
-        if (\in_array($this->internalResponse->getStatus(), array(301, 302, 303))) {
+        if (\in_array($this->internalResponse->getStatusCode(), array(301, 302, 303))) {
             $method = 'GET';
             $files = array();
             $content = null;
diff --git a/src/Symfony/Component/BrowserKit/Response.php b/src/Symfony/Component/BrowserKit/Response.php
@@ -83,8 +83,17 @@ public function getContent()
      * Gets the response status code.
      *
      * @return int The response status code
+     *
+     * @deprecated since Symfony 4.3, use getStatusCode() instead
      */
     public function getStatus()
+    {
+        @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.3, use getStatusCode() instead.', __METHOD__), E_USER_DEPRECATED);
+
+        return $this->status;
+    }
+
+    public function getStatusCode(): int
     {
         return $this->status;
     }
diff --git a/src/Symfony/Component/BrowserKit/Tests/ClientTest.php b/src/Symfony/Component/BrowserKit/Tests/ClientTest.php
@@ -52,7 +52,7 @@ protected function doRequest($request)
     protected function filterResponse($response)
     {
         if ($response instanceof SpecialResponse) {
-            return new Response($response->getContent(), $response->getStatus(), $response->getHeaders());
+            return new Response($response->getContent(), $response->getStatusCode(), $response->getHeaders());
         }
 
         return $response;
diff --git a/src/Symfony/Component/BrowserKit/Tests/ResponseTest.php b/src/Symfony/Component/BrowserKit/Tests/ResponseTest.php
@@ -22,12 +22,21 @@ public function testGetUri()
         $this->assertEquals('foo', $response->getContent(), '->getContent() returns the content of the response');
     }
 
+    /**
+     * @group legacy
+     */
     public function testGetStatus()
     {
         $response = new Response('foo', 304);
         $this->assertEquals('304', $response->getStatus(), '->getStatus() returns the status of the response');
     }
 
+    public function testGetStatusCode()
+    {
+        $response = new Response('foo', 304);
+        $this->assertEquals('304', $response->getStatusCode(), '->getStatusCode() returns the status of the response');
+    }
+
     public function testGetHeaders()
     {
         $response = new Response('foo', 200, array('foo' => 'bar'));

Original file line number	Diff line number	Diff line change
`@@ -83,8 +83,17 @@ public function getContent()`
`83`	`83`	`* Gets the response status code.`
`84`	`84`	`*`
`85`	`85`	`* @return int The response status code`
	`86`	`+ *`
	`87`	`+ * @deprecated since Symfony 4.3, use getStatusCode() instead`
`86`	`88`	`*/`
`87`	`89`	`public function getStatus()`
	`90`	`+ {`
	`91`	`+ @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.3, use getStatusCode() instead.', __METHOD__), E_USER_DEPRECATED);`
	`92`	`+`
	`93`	`+ return $this->status;`
	`94`	`+ }`
	`95`	`+`
	`96`	`+ public function getStatusCode(): int`
`88`	`97`	`{`
`89`	`98`	`return $this->status;`
`90`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ protected function doRequest($request)`
`52`	`52`	`protected function filterResponse($response)`
`53`	`53`	`{`
`54`	`54`	`if ($response instanceof SpecialResponse) {`
`55`		`- return new Response($response->getContent(), $response->getStatus(), $response->getHeaders());`
	`55`	`+ return new Response($response->getContent(), $response->getStatusCode(), $response->getHeaders());`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`return $response;`
Original file line number	Diff line number	Diff line change
`@@ -22,12 +22,21 @@ public function testGetUri()`
`22`	`22`	`$this->assertEquals('foo', $response->getContent(), '->getContent() returns the content of the response');`
`23`	`23`	`}`
`24`	`24`
	`25`	`+ /**`
	`26`	`+ * @group legacy`
	`27`	`+ */`
`25`	`28`	`public function testGetStatus()`
`26`	`29`	`{`
`27`	`30`	`$response = new Response('foo', 304);`
`28`	`31`	`$this->assertEquals('304', $response->getStatus(), '->getStatus() returns the status of the response');`
`29`	`32`	`}`
`30`	`33`
	`34`	`+ public function testGetStatusCode()`
	`35`	`+ {`
	`36`	`+ $response = new Response('foo', 304);`
	`37`	`+ $this->assertEquals('304', $response->getStatusCode(), '->getStatusCode() returns the status of the response');`
	`38`	`+ }`
	`39`	`+`
`31`	`40`	`public function testGetHeaders()`
`32`	`41`	`{`
`33`	`42`	`$response = new Response('foo', 200, array('foo' => 'bar'));`