bug #34167 [HttpFoundation] Allow to not pass a parameter to Request::isMethodSafe() (dunglas)

nicolas-grekas · nicolas-grekas · commit 2326f2882c10 · 2019-10-29T14:51:20.000+01:00
This PR was squashed before being merged into the 4.3 branch. Discussion ---------- [HttpFoundation] Allow to not pass a parameter to Request::isMethodSafe() | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | n/a | License | MIT | Doc PR | n/a This parameter was already deprecated in Symfony 4. Allowing to not pass it in Symfony 4.3 without triggering a deprecation allows to support both HttpFoundation 4.3 and 4.4, otherwise it's not possible. Needed to make API Platform compatible with Symfony 5 (api-platform/core#3009) Commits ------- e819256 [HttpFoundation] Allow to not pass a parameter to Request::isMethodSafe()
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1447,14 +1447,11 @@ public function isMethod($method)
      *
      * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
      *
-     * @param bool $andCacheable Adds the additional condition that the method should be cacheable. True by default.
-     *
      * @return bool
      */
-    public function isMethodSafe(/* $andCacheable = true */)
+    public function isMethodSafe()
     {
-        if (!\func_num_args() || func_get_arg(0)) {
-            // setting $andCacheable to false should be deprecated in 4.1
+        if (\func_num_args() > 0 && func_get_arg(0)) {
             throw new \BadMethodCallException('Checking only for cacheable HTTP methods with Symfony\Component\HttpFoundation\Request::isMethodSafe() is not supported.');
         }
 
diff --git a/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php b/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php
@@ -2132,7 +2132,7 @@ public function testMethodSafeChecksCacheable()
         $this->expectException('BadMethodCallException');
         $request = new Request();
         $request->setMethod('OPTIONS');
-        $request->isMethodSafe();
+        $request->isMethodSafe(true);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -1447,14 +1447,11 @@ public function isMethod($method)`
`1447`	`1447`	`*`
`1448`	`1448`	`* @see https://tools.ietf.org/html/rfc7231#section-4.2.1`
`1449`	`1449`	`*`
`1450`		`- * @param bool $andCacheable Adds the additional condition that the method should be cacheable. True by default.`
`1451`		`- *`
`1452`	`1450`	`* @return bool`
`1453`	`1451`	`*/`
`1454`		`- public function isMethodSafe(/* $andCacheable = true */)`
	`1452`	`+ public function isMethodSafe()`
`1455`	`1453`	`{`
`1456`		`- if (!\func_num_args() \|\| func_get_arg(0)) {`
`1457`		`- // setting $andCacheable to false should be deprecated in 4.1`
	`1454`	`+ if (\func_num_args() > 0 && func_get_arg(0)) {`
`1458`	`1455`	`throw new \BadMethodCallException('Checking only for cacheable HTTP methods with Symfony\Component\HttpFoundation\Request::isMethodSafe() is not supported.');`
`1459`	`1456`	`}`
`1460`	`1457`
Original file line number	Diff line number	Diff line change
`@@ -2132,7 +2132,7 @@ public function testMethodSafeChecksCacheable()`
`2132`	`2132`	`$this->expectException('BadMethodCallException');`
`2133`	`2133`	`$request = new Request();`
`2134`	`2134`	`$request->setMethod('OPTIONS');`
`2135`		`- $request->isMethodSafe();`
	`2135`	`+ $request->isMethodSafe(true);`
`2136`	`2136`	`}`
`2137`	`2137`
`2138`	`2138`	`/**`