Commit 7a9f1a0c by Brandon Kelly

getQueryParam() and getBodyParam() doc edits

- Made yii\web\Request::getQueryParam() and getBodyParam()'s doc blocks more consistent with each other - getQueryParam() was incorrectly stating that if $name was omitted, all of $_GET would be returned (but $name is required)
parent 46048864
...@@ -416,6 +416,7 @@ class Request extends \yii\base\Request ...@@ -416,6 +416,7 @@ class Request extends \yii\base\Request
/** /**
* Returns the named request body parameter value. * Returns the named request body parameter value.
* If the parameter does not exist, the second parameter passed to this method will be returned.
* @param string $name the parameter name * @param string $name the parameter name
* @param mixed $defaultValue the default parameter value if the parameter does not exist. * @param mixed $defaultValue the default parameter value if the parameter does not exist.
* @return mixed the parameter value * @return mixed the parameter value
...@@ -492,8 +493,8 @@ class Request extends \yii\base\Request ...@@ -492,8 +493,8 @@ class Request extends \yii\base\Request
/** /**
* Returns the named GET parameter value. * Returns the named GET parameter value.
* If the GET parameter does not exist, the second parameter to this method will be returned. * If the GET parameter does not exist, the second parameter passed to this method will be returned.
* @param string $name the GET parameter name. If not specified, whole $_GET is returned. * @param string $name the GET parameter name.
* @param mixed $defaultValue the default parameter value if the GET parameter does not exist. * @param mixed $defaultValue the default parameter value if the GET parameter does not exist.
* @return mixed the GET parameter value * @return mixed the GET parameter value
* @see getBodyParam() * @see getBodyParam()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment