minor #40973 [HttpFoundation] Small phpdoc improvement (flack)

fabpot · fabpot · commit 8679945b4386 · 2021-04-30T14:05:50.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [HttpFoundation] Small phpdoc improvement | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | I have been looking for a way to emulate `$_REQUEST` in Symfony, and I always thought the `get` method is useless for that, because it only looks at some custom routing stuff, GET and whatever BODY might be. Only today I actually looked at the source code and found out that it's actually (almost) doing what I was looking for, i.e. check `$_GET`, and then `$_POST`. So I figured it would be good to be a bit more explicit in the phpdoc (analoguous to the phpdoc for `$request->request`, which says "Request body parameters ($_POST)."). Commits ------- a53f256 Small phpdoc imporvement
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -686,7 +686,7 @@ public static function getHttpMethodParameterOverride()
      * flexibility in controllers, it is better to explicitly get request parameters from the appropriate
      * public property instead (attributes, query, request).
      *
-     * Order of precedence: PATH (routing placeholders or custom attributes), GET, BODY
+     * Order of precedence: PATH (routing placeholders or custom attributes), GET, POST
      *
      * @param string $key     The key
      * @param mixed  $default The default value if the parameter key does not exist

Original file line number	Diff line number	Diff line change
`@@ -686,7 +686,7 @@ public static function getHttpMethodParameterOverride()`
`686`	`686`	`* flexibility in controllers, it is better to explicitly get request parameters from the appropriate`
`687`	`687`	`* public property instead (attributes, query, request).`
`688`	`688`	`*`
`689`		`- * Order of precedence: PATH (routing placeholders or custom attributes), GET, BODY`
	`689`	`+ * Order of precedence: PATH (routing placeholders or custom attributes), GET, POST`
`690`	`690`	`*`
`691`	`691`	`* @param string $key The key`
`692`	`692`	`* @param mixed $default The default value if the parameter key does not exist`