minor #29295 [Request] [Documentation] clarify that isMethodCacheable() returns true only for GET & HEAD (tamc)

fabpot · fabpot · commit f02874e70f5c · 2018-11-26T07:39:41.000+01:00
This PR was merged into the 2.8 branch. Discussion ---------- [Request] [Documentation] clarify that isMethodCacheable() returns true only for GET & HEAD | Q | A | ------------- | --- | Branch? | 2.8 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | na | License | MIT The current documentation points to https://tools.ietf.org/html/rfc7231#section-4.2.3. The spec says: "this specification defines GET, HEAD, and POST as cacheable, although the overwhelming majority of cache implementations only support GET and HEAD.". This fix to the documentation clarifies that Symfony follows majority (excluding POST) rather than the spec (including POST). Commits ------- 9da9980 Doc fix: clarify isMethodCacheable() returns true only for GET & HEAD
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1475,7 +1475,7 @@ public function isMethodSafe(/* $andCacheable = true */)
      *
      * @see https://tools.ietf.org/html/rfc7231#section-4.2.3
      *
-     * @return bool
+     * @return bool True for GET and HEAD, false otherwise
      */
     public function isMethodCacheable()
     {

Original file line number	Diff line number	Diff line change
`@@ -1475,7 +1475,7 @@ public function isMethodSafe(/* $andCacheable = true */)`
`1475`	`1475`	`*`
`1476`	`1476`	`* @see https://tools.ietf.org/html/rfc7231#section-4.2.3`
`1477`	`1477`	`*`
`1478`		`- * @return bool`
	`1478`	`+ * @return bool True for GET and HEAD, false otherwise`
`1479`	`1479`	`*/`
`1480`	`1480`	`public function isMethodCacheable()`
`1481`	`1481`	`{`