Merge branch 'request-params-refactoring' of github.com:cebe/yii2 into…

extensions/bootstrap/Nav.php

@@ -100,7 +100,7 @@ class Nav extends Widget
 			$this->route = Yii::$app->controller->getRoute();
 		}
 		if ($this->params === null) {
-			$this->params = $_GET;
+			$this->params = Yii::$app->request->getQueryParams();
 		}
 		Html::addCssClass($this->options, 'nav');
 	}

extensions/debug/assets/main.css

@@ -25,10 +25,15 @@ ul.trace {
 }
 
 td, th {
-	white-space: pre-line;
+	white-space: pre-wrap;
 	word-wrap: break-word;
 }
 
+.request-table td {
+	font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
+	word-break: break-all;
+}
+
 .detail-grid-view th {
     white-space: nowrap;
 }

extensions/debug/panels/DbPanel.php

@@ -53,7 +53,7 @@ class DbPanel extends Panel
 	public function getDetail()
 	{
 		$searchModel = new Db();
-		$dataProvider = $searchModel->search(Yii::$app->request->get(), $this->getModels());
+		$dataProvider = $searchModel->search(Yii::$app->request->getQueryParams(), $this->getModels());
 
 		return Yii::$app->view->render('panels/db/detail', [
 			'panel' => $this,

extensions/debug/panels/LogPanel.php

@@ -39,7 +39,7 @@ class LogPanel extends Panel
 	public function getDetail()
 	{
 		$searchModel = new Log();
-		$dataProvider = $searchModel->search(Yii::$app->request->get(), $this->getModels());
+		$dataProvider = $searchModel->search(Yii::$app->request->getQueryParams(), $this->getModels());
 
 		return Yii::$app->view->render('panels/log/detail', [
 			'dataProvider' => $dataProvider, 

extensions/debug/panels/ProfilingPanel.php

@@ -42,7 +42,7 @@ class ProfilingPanel extends Panel
 	public function getDetail()
 	{
 		$searchModel = new Profile();
-		$dataProvider = $searchModel->search(Yii::$app->request->get(), $this->getModels());
+		$dataProvider = $searchModel->search(Yii::$app->request->getQueryParams(), $this->getModels());
 
 		return Yii::$app->view->render('panels/profile/detail', [
 			'panel' => $this,

extensions/debug/panels/RequestPanel.php

@@ -82,6 +82,11 @@ class RequestPanel extends Panel
 			'route' => Yii::$app->requestedAction ? Yii::$app->requestedAction->getUniqueId() : Yii::$app->requestedRoute,
 			'action' => $action,
 			'actionParams' => Yii::$app->requestedParams,
+			'requestBody' => Yii::$app->getRequest()->getRawBody() == '' ? [] : [
+				'Content Type' => Yii::$app->getRequest()->getContentType(),
+				'Raw' => Yii::$app->getRequest()->getRawBody(),
+				'Decoded to Params' => Yii::$app->getRequest()->getBodyParams(),
+			],
 			'SERVER' => empty($_SERVER) ? [] : $_SERVER,
 			'GET' => empty($_GET) ? [] : $_GET,
 			'POST' => empty($_POST) ? [] : $_POST,

extensions/debug/views/default/panels/request/detail.php

@@ -13,7 +13,8 @@ echo Tabs::widget([
 				. $this->render('panels/request/table', ['caption' => '$_GET', 'values' => $panel->data['GET']])
 				. $this->render('panels/request/table', ['caption' => '$_POST', 'values' => $panel->data['POST']])
 				. $this->render('panels/request/table', ['caption' => '$_FILES', 'values' => $panel->data['FILES']])
-				. $this->render('panels/request/table', ['caption' => '$_COOKIE', 'values' => $panel->data['COOKIE']]),
+				. $this->render('panels/request/table', ['caption' => '$_COOKIE', 'values' => $panel->data['COOKIE']])
+				. $this->render('panels/request/table', ['caption' => 'Request Body', 'values' => $panel->data['requestBody']]),
 			'active' => true,
 		],
 		[

extensions/debug/views/default/panels/request/table.php

@@ -15,7 +15,7 @@ use yii\helpers\VarDumper;
 
 <?php else:	?>
 
-	<table class="table table-condensed table-bordered table-striped table-hover" style="table-layout: fixed;">
+	<table class="table table-condensed table-bordered table-striped table-hover request-table" style="table-layout: fixed;">
 		<thead>
 			<tr>
 				<th style="width: 200px;">Name</th>

extensions/gii/generators/crud/templates/controller.php

@@ -59,7 +59,7 @@ class <?= $controllerClass ?> extends <?= StringHelper::basename($generator->bas
 	public function actionIndex()
 	{
 		$searchModel = new <?= isset($searchModelAlias) ? $searchModelAlias : $searchModelClass ?>;
-		$dataProvider = $searchModel->search($_GET);
+		$dataProvider = $searchModel->search(Yii::$app->request->getQueryParams());
 
 		return $this->render('index', [
 			'dataProvider' => $dataProvider,

framework/CHANGELOG.md

@@ -118,6 +118,9 @@ Yii Framework 2 Change Log
 - Chg #1852: DbConnection::tablePrefix default value now 'tbl_' (creocoder)
 - Chg #1958: `beforeSubmit` in `yii.activeform` is now executed after validation and before form submission (6pblcb)
 - Chg #2025: Removed ability to declare scopes in ActiveRecord (samdark)
+- Chg #2043: Renamed `yii\web\Request::acceptedLanguages` to `acceptableLanguages` (qiangxue)
+- Chg #2043: Removed `yii\web\Request::getPut()`, `getDelete()`, `getPatch()` in favor of `getBodyParam()` (cebe)
+- Chg #2043: Renamed `yii\web\Request::get()` to `getQueryParams()` and `getRestParams()` to `getBodyParams()` (cebe)
 - Chg #2057: AutoTimestamp attributes defaults changed from `create_time` and `update_time` to `created_at` and `updated_at` (creocoder)
 - Chg #2063: Removed `yii\web\Request::acceptTypes` and renamed `yii\web\Request::acceptedContentTypes` to `acceptableContentTypes` (qiangxue)
 - Chg #2157: The '*' category pattern will match all categories that do not match any other patterns listed in `I18N::translations` (qiangxue, Ragazzo)

framework/data/Pagination.php

@@ -141,7 +141,7 @@ class Pagination extends Object
 		if ($this->_page === null || $recalculate) {
 			if (($params = $this->params) === null) {
 				$request = Yii::$app->getRequest();
-				$params = $request instanceof Request ? $request->get() : [];
+				$params = $request instanceof Request ? $request->getQueryParams() : [];
 			}
 			if (isset($params[$this->pageVar]) && is_scalar($params[$this->pageVar])) {
 				$this->_page = (int)$params[$this->pageVar] - 1;
@@ -183,7 +183,7 @@ class Pagination extends Object
 	{
 		if (($params = $this->params) === null) {
 			$request = Yii::$app->getRequest();
-			$params = $request instanceof Request ? $request->get() : [];
+			$params = $request instanceof Request ? $request->getQueryParams() : [];
 		}
 		if ($page > 0 || $page >= 0 && $this->forcePageVar) {
 			$params[$this->pageVar] = $page + 1;

framework/data/Sort.php

@@ -245,7 +245,7 @@ class Sort extends Object
 			$this->_attributeOrders = [];
 			if (($params = $this->params) === null) {
 				$request = Yii::$app->getRequest();
-				$params = $request instanceof Request ? $request->get() : [];
+				$params = $request instanceof Request ? $request->getQueryParams() : [];
 			}
 			if (isset($params[$this->sortVar]) && is_scalar($params[$this->sortVar])) {
 				$attributes = explode($this->separators[0], $params[$this->sortVar]);
@@ -341,7 +341,7 @@ class Sort extends Object
 	{
 		if (($params = $this->params) === null) {
 			$request = Yii::$app->getRequest();
-			$params = $request instanceof Request ? $request->get() : [];
+			$params = $request instanceof Request ? $request->getQueryParams() : [];
 		}
 		$params[$this->sortVar] = $this->createSortVar($attribute);
 		$route = $this->route === null ? Yii::$app->controller->getRoute() : $this->route;

framework/helpers/BaseHtml.php

@@ -237,7 +237,7 @@ class BaseHtml
 		if ($request instanceof Request) {
 			if (strcasecmp($method, 'get') && strcasecmp($method, 'post')) {
 				// simulate PUT, DELETE, etc. via POST
-				$hiddenInputs[] = static::hiddenInput($request->restVar, $method);
+				$hiddenInputs[] = static::hiddenInput($request->methodVar, $method);
 				$method = 'post';
 			}
 			if ($request->enableCsrfValidation && !strcasecmp($method, 'post')) {

framework/web/Request.php

@@ -9,8 +9,6 @@ namespace yii\web;
 
 use Yii;
 use yii\base\InvalidConfigException;
-use yii\base\InvalidParamException;
-use yii\helpers\Json;
 use yii\helpers\Security;
 use yii\helpers\StringHelper;
 
@@ -125,11 +123,11 @@ class Request extends \yii\base\Request
 	 * @var string|boolean the name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE
 	 * request tunneled through POST. Default to '_method'.
 	 * @see getMethod()
-	 * @see getRestParams()
+	 * @see getBodyParams()
 	 */
-	public $restVar = '_method';
+	public $methodVar = '_method';
 	/**
-	 * @var array the parsers for converting the raw HTTP request body into [[restParams]].
+	 * @var array the parsers for converting the raw HTTP request body into [[bodyParams]].
 	 * The array keys are the request `Content-Types`, and the array values are the
 	 * corresponding configurations for [[Yii::createObject|creating the parser objects]].
 	 * A parser must implement the [[RequestParserInterface]].
@@ -145,7 +143,7 @@ class Request extends \yii\base\Request
 	 * To register a parser for parsing all request types you can use `'*'` as the array key.
 	 * This one will be used as a fallback in case no other types match.
 	 *
-	 * @see getRestParams()
+	 * @see getBodyParams()
 	 */
 	public $parsers = [];
 
@@ -211,8 +209,8 @@ class Request extends \yii\base\Request
 	 */
 	public function getMethod()
 	{
-		if (isset($_POST[$this->restVar])) {
-			return strtoupper($_POST[$this->restVar]);
+		if (isset($_POST[$this->methodVar])) {
+			return strtoupper($_POST[$this->methodVar]);
 		} else {
 			return isset($_SERVER['REQUEST_METHOD']) ? strtoupper($_SERVER['REQUEST_METHOD']) : 'GET';
 		}
@@ -300,78 +298,112 @@ class Request extends \yii\base\Request
 			(stripos($_SERVER['HTTP_USER_AGENT'], 'Shockwave') !== false || stripos($_SERVER['HTTP_USER_AGENT'], 'Flash') !== false);
 	}
 
-	private $_restParams;
+	private $_rawBody;
+
+	/**
+	 * Returns the raw HTTP request body.
+	 * @return string the request body
+	 */
+	public function getRawBody()
+	{
+		if ($this->_rawBody === null) {
+			$this->_rawBody = file_get_contents('php://input');
+		}
+		return $this->_rawBody;
+	}
+
+	private $_bodyParams;
 
 	/**
-	 * Returns the request parameters for the RESTful request.
+	 * Returns the request parameters given in the request body.
 	 *
 	 * Request parameters are determined using the parsers configured in [[parsers]] property.
 	 * If no parsers are configured for the current [[contentType]] it uses the PHP function [[mb_parse_str()]]
 	 * to parse the [[rawBody|request body]].
-	 * @return array the RESTful request parameters
+	 * @return array the request parameters given in the request body.
 	 * @throws \yii\base\InvalidConfigException if a registered parser does not implement the [[RequestParserInterface]].
 	 * @see getMethod()
+	 * @see getBodyParam()
+	 * @see setBodyParams()
 	 */
-	public function getRestParams()
+	public function getBodyParams()
 	{
-		if ($this->_restParams === null) {
+		if ($this->_bodyParams === null) {
 			$contentType = $this->getContentType();
-			if (isset($_POST[$this->restVar])) {
-				$this->_restParams = $_POST;
-				unset($this->_restParams[$this->restVar]);
+			if (isset($_POST[$this->methodVar])) {
+				$this->_bodyParams = $_POST;
+				unset($this->_bodyParams[$this->methodVar]);
 			} elseif (isset($this->parsers[$contentType])) {
 				$parser = Yii::createObject($this->parsers[$contentType]);
 				if (!($parser instanceof RequestParserInterface)) {
 					throw new InvalidConfigException("The '$contentType' request parser is invalid. It must implement the yii\\web\\RequestParserInterface.");
 				}
-				$this->_restParams = $parser->parse($this->getRawBody(), $contentType);
+				$this->_bodyParams = $parser->parse($this->getRawBody(), $contentType);
 			} elseif (isset($this->parsers['*'])) {
 				$parser = Yii::createObject($this->parsers['*']);
 				if (!($parser instanceof RequestParserInterface)) {
 					throw new InvalidConfigException("The fallback request parser is invalid. It must implement the yii\\web\\RequestParserInterface.");
 				}
-				$this->_restParams = $parser->parse($this->getRawBody(), $contentType);
+				$this->_bodyParams = $parser->parse($this->getRawBody(), $contentType);
 			} else {
-				$this->_restParams = [];
-				mb_parse_str($this->getRawBody(), $this->_restParams);
+				$this->_bodyParams = [];
+				mb_parse_str($this->getRawBody(), $this->_bodyParams);
 			}
 		}
-		return $this->_restParams;
+		return $this->_bodyParams;
 	}
 
-	private $_rawBody;
-
 	/**
-	 * Returns the raw HTTP request body.
-	 * @return string the request body
+	 * Sets the request body parameters.
+	 * @param array $values the request body parameters (name-value pairs)
+	 * @see getBodyParam()
+	 * @see getBodyParams()
 	 */
-	public function getRawBody()
+	public function setBodyParams($values)
 	{
-		if ($this->_rawBody === null) {
-			$this->_rawBody = file_get_contents('php://input');
+		$this->_bodyParams = $values;
 	}
-		return $this->_rawBody;
+
+	/**
+	 * Returns the named request body parameter value.
+	 * @param string $name the parameter name
+	 * @param mixed $defaultValue the default parameter value if the parameter does not exist.
+	 * @return mixed the parameter value
+	 * @see getBodyParams()
+	 * @see setBodyParams()
+	 */
+	public function getBodyParam($name, $defaultValue = null)
+	{
+		$params = $this->getBodyParams();
+		return isset($params[$name]) ? $params[$name] : $defaultValue;
 	}
 
+	private $_queryParams;
+
 	/**
-	 * Sets the RESTful parameters.
-	 * @param array $values the RESTful parameters (name-value pairs)
+	 * Returns the request parameters given in the [[queryString]].
+	 *
+	 * This method will return the contents of `$_GET` if params where not explicitly set.
+	 * @return array the request GET parameter values.
+	 * @see setQueryParams()
 	 */
-	public function setRestParams($values)
+	public function getQueryParams()
 	{
-		$this->_restParams = $values;
+		if ($this->_queryParams === null) {
+			return $_GET;
+		}
+		return $this->_queryParams;
 	}
 
 	/**
-	 * Returns the named RESTful parameter value.
-	 * @param string $name the parameter name
-	 * @param mixed $defaultValue the default parameter value if the parameter does not exist.
-	 * @return mixed the parameter value
+	 * Sets the request [[queryString]] parameters.
+	 * @param array $values the request query parameters (name-value pairs)
+	 * @see getQueryParam()
+	 * @see getQueryParams()
 	 */
-	public function getRestParam($name, $defaultValue = null)
+	public function setQueryParams($values)
 	{
-		$params = $this->getRestParams();
-		return isset($params[$name]) ? $params[$name] : $defaultValue;
+		$this->_queryParams = $values;
 	}
 
 	/**
@@ -382,12 +414,10 @@ class Request extends \yii\base\Request
 	 * @return mixed the GET parameter value
 	 * @see getPost()
 	 */
-	public function get($name = null, $defaultValue = null)
+	public function getQueryParam($name, $defaultValue = null)
 	{
-		if ($name === null) {
-			return $_GET;
-		}
-		return isset($_GET[$name]) ? $_GET[$name] : $defaultValue;
+		$params = $this->getQueryParams();
+		return isset($params[$name]) ? $params[$name] : $defaultValue;
 	}
 
 	/**
@@ -399,7 +429,7 @@ class Request extends \yii\base\Request
 	 * @return mixed the POST parameter value
 	 * @see get()
 	 */
-	public function getPost($name = null, $defaultValue = null)
+	public function getPostParam($name = null, $defaultValue = null)
 	{
 		if ($name === null) {
 			return $_POST;
@@ -407,51 +437,6 @@ class Request extends \yii\base\Request
 		return isset($_POST[$name]) ? $_POST[$name] : $defaultValue;
 	}
 
-	/**
-	 * Returns the named DELETE parameter value.
-	 * @param string $name the DELETE parameter name. If not specified, an array of DELETE parameters is returned.
-	 * @param mixed $defaultValue the default parameter value if the DELETE parameter does not exist.
-	 * @property array the DELETE request parameter values
-	 * @return mixed the DELETE parameter value
-	 */
-	public function getDelete($name = null, $defaultValue = null)
-	{
-		if ($name === null) {
-			return $this->getRestParams();
-		}
-		return $this->getIsDelete() ? $this->getRestParam($name, $defaultValue) : null;
-	}
-
-	/**
-	 * Returns the named PUT parameter value.
-	 * @param string $name the PUT parameter name. If not specified, an array of PUT parameters is returned.
-	 * @param mixed $defaultValue the default parameter value if the PUT parameter does not exist.
-	 * @property array the PUT request parameter values
-	 * @return mixed the PUT parameter value
-	 */
-	public function getPut($name = null, $defaultValue = null)
-	{
-		if ($name === null) {
-			return $this->getRestParams();
-		}
-		return $this->getIsPut() ? $this->getRestParam($name, $defaultValue) : null;
-	}
-
-	/**
-	 * Returns the named PATCH parameter value.
-	 * @param string $name the PATCH parameter name. If not specified, an array of PATCH parameters is returned.
-	 * @param mixed $defaultValue the default parameter value if the PATCH parameter does not exist.
-	 * @property array the PATCH request parameter values
-	 * @return mixed the PATCH parameter value
-	 */
-	public function getPatch($name = null, $defaultValue = null)
-	{
-		if ($name === null) {
-			return $this->getRestParams();
-		}
-		return $this->getIsPatch() ? $this->getRestParam($name, $defaultValue) : null;
-	}
-
 	private $_hostInfo;
 
 	/**
@@ -1186,24 +1171,12 @@ class Request extends \yii\base\Request
 	public function validateCsrfToken()
 	{
 		$method = $this->getMethod();
-		if (!$this->enableCsrfValidation || !in_array($method, ['POST', 'PUT', 'PATCH', 'DELETE'], true)) {
+		// only validate CSRF token on non-"safe" methods http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.1
+		if (!$this->enableCsrfValidation || in_array($method, ['GET', 'HEAD', 'OPTIONS'], true)) {
 			return true;
 		}
 		$trueToken = $this->getCookies()->getValue($this->csrfVar);
-		switch ($method) {
-			case 'PUT':
-				$token = $this->getPut($this->csrfVar);
-				break;
-			case 'PATCH':
-				$token = $this->getPatch($this->csrfVar);
-				break;
-			case 'DELETE':
-				$token = $this->getDelete($this->csrfVar);
-				break;
-			default:
-				$token = $this->getPost($this->csrfVar);
-				break;
-		}
+		$token = $this->getBodyParam($this->csrfVar);
 		return $this->validateCsrfTokenInternal($token, $trueToken)
 			|| $this->validateCsrfTokenInternal($this->getCsrfTokenFromHeader(), $trueToken);
 	}

framework/web/UrlManager.php

@@ -217,7 +217,7 @@ class UrlManager extends Component
 			return [$pathInfo, []];
 		} else {
 			Yii::trace('Pretty URL not enabled. Using default URL parsing logic.', __METHOD__);
-			$route = $request->get($this->routeVar);
+			$route = $request->getQueryParam($this->routeVar, '');
 			if (is_array($route)) {
 				$route = '';
 			}

framework/widgets/Menu.php

@@ -158,7 +158,7 @@ class Menu extends Widget
 			$this->route = Yii::$app->controller->getRoute();
 		}
 		if ($this->params === null) {
-			$this->params = $_GET;
+			$this->params = Yii::$app->request->getQueryParams();
 		}
 		$items = $this->normalizeItems($this->items, $hasActiveChild);
 		$options = $this->options;