Web应用Request¶

// 返回当前请求的方法，请留意方法名称是大小写敏感的，按规范应转换为大写字母
public function getMethod()
{
    // $this->methodParam 默认值为 '_method'
    // 如果指定 $_POST['_method'] ，表示使用POST请求来模拟其他方法的请求。
    // 此时 $_POST['_method'] 即为所模拟的请求类型。
    if (isset($_POST[$this->methodParam])) {
        return strtoupper($_POST[$this->methodParam]);

    // 或者使用 $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'] 的值作为方法名。
    } elseif (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) {
        return strtoupper($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']);

    // 或者使用 $_SERVER['REQUEST_METHOD'] 作为方法名，未指定时，默认为 GET 方法
    } else {
        return isset($_SERVER['REQUEST_METHOD']) ?
            strtoupper($_SERVER['REQUEST_METHOD']) : 'GET';
    }
}

if ($app->request->isDelete()){
    $post->delete();
} else {
    $post->view();
}

// 这个SO EASY，啥也不说了，Yii实现的7个HTTP方法都是这个路子。
public function getIsOptions()
{
    // 注意在getMethod()时，输出的是全部大写的字符串
    return $this->getMethod() === 'OPTIONS';
}

// AJAX请求是通过 X_REQUESTED_WITH 消息头来判断的
public function getIsAjax()
{
    // 注意这里的XMLHttpRequest没有全部大写
    return isset($_SERVER['HTTP_X_REQUESTED_WITH']) &&
        $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest';
}

// PJAX请求是AJAX请求的一种，增加了X_PJAX消息头的定义
public function getIsPjax()
{
    return $this->getIsAjax() && !empty($_SERVER['HTTP_X_PJAX']);
}

// HTTP_USER_AGENT消息头中包含 'Shockwave' 或 'Flash' 字眼的（不区分大小写），
// 就认为是FLASH请求
public function getIsFlash()
{
    return isset($_SERVER['HTTP_USER_AGENT'])
        && (stripos($_SERVER['HTTP_USER_AGENT'], 'Shockwave') !== false
        || stripos($_SERVER['HTTP_USER_AGENT'], 'Flash') !== false);
}

// 用于获取GET参数，可以指定参数名和默认值
public function get($name = null, $defaultValue = null)
{
    if ($name === null) {
        return $this->getQueryParams();
    } else {
        return $this->getQueryParam($name, $defaultValue);
    }
}

// 用于获取所有的GET参数
// 所有的GET参数保存在 $_GET 或 $this->_queryParams 中。
public function getQueryParams()
{
    if ($this->_queryParams === null) {
        // 请留意这里并未使用 $this->_queryParams = $_GET 进行缓存。
        // 说明一旦指定了 $_queryParams 则 $_GET 会失效。
        return $_GET;
    }

    return $this->_queryParams;
}

// 根据参数名获取单一的GET参数，不存在时，返回指定的默认值
public function getQueryParam($name, $defaultValue = null)
{
    $params = $this->getQueryParams();
    return isset($params[$name]) ? $params[$name] : $defaultValue;
}

// 类以于get()，用于获取POST参数，也可以指定参数名和默认值
public function post($name = null, $defaultValue = null)
{
    if ($name === null) {
        return $this->getBodyParams();
    } else {
        return $this->getBodyParam($name, $defaultValue);
    }
}

// 根据参数名获取单一的POST参数，不存在时，返回指定的默认值
public function getBodyParam($name, $defaultValue = null)
{
    $params = $this->getBodyParams();
    return isset($params[$name]) ? $params[$name] : $defaultValue;
}

// 获取所有POST参数，所有POST参数保存在 $this->_bodyParams 中
public function getBodyParams()
{
    if ($this->_bodyParams === null) {
        // 如果是使用 POST 请求模拟其他请求的
        if (isset($_POST[$this->methodParam])) {
            $this->_bodyParams = $_POST;

            // 将 $_POST['_method'] 删掉，剩余的$_POST就是了
            unset($this->_bodyParams[$this->methodParam]);
            return $this->_bodyParams;
        }

        // 获取Content Type
        // 对于 'application/json; charset=UTF-8'，得到的是 'application/json'
        $contentType = $this->getContentType();
        if (($pos = strpos($contentType, ';')) !== false) {
            $contentType = substr($contentType, 0, $pos);
        }

        // 根据Content Type 选择相应的解析器对请求体进行解析
        if (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->_bodyParams
            $this->_bodyParams = $parser->parse($this->getRawBody(), $contentType);

        // 如果没有与Content Type对应的解析器，使用通用解析器
        } 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->_bodyParams = $parser->parse($this->getRawBody(),
                $contentType);

        // 连通用解析器也没有
        // 看看是不是POST请求，如果是，PHP已经将请求参数放到$_POST中了，直接用就OK了
        } elseif ($this->getMethod() === 'POST') {
            $this->_bodyParams = $_POST;

        // 以上情况都不是，那就使用PHP的 mb_parse_str() 进行解析
        } else {
            $this->_bodyParams = [];
            mb_parse_str($this->getRawBody(), $this->_bodyParams);
        }
    }

    return $this->_bodyParams;
}

public function getHeaders()
{
    if ($this->_headers === null) {

        // 实例化为一个HeaderCollection
        $this->_headers = new HeaderCollection;

        // 使用 getallheaders() 获取请求头部，以数组形式返回
        if (function_exists('getallheaders')) {
            $headers = getallheaders();

        // 使用 http_get_request_headers() 获取请求头部，以数组形式返回
        } elseif (function_exists('http_get_request_headers')) {
            $headers = http_get_request_headers();

        // 使用 $_SERVER 数组获取头部
        } else {
            foreach ($_SERVER as $name => $value) {

                // 针对所有 $_SERVER['HTTP_*'] 元素
                if (strncmp($name, 'HTTP_', 5) === 0) {
                    // 将 HTTP_HEADER_NAME 转换成 Header-Name 的形式
                    $name = str_replace(' ', '-',
                        ucwords(strtolower(str_replace('_', ' ',
                            substr($name, 5)))));
                    $this->_headers->add($name, $value);
                }
            }

            return $this->_headers;
        }

        // 将数组形式的请求头部变成集合的元素
        foreach ($headers as $name => $value) {
            $this->_headers->add($name, $value);
        }
    }

    return $this->_headers;
}

public function resolve()
{
    // 使用urlManager来解析请求
    $result = Yii::$app->getUrlManager()->parseRequest($this);
    if ($result !== false) {
        list ($route, $params) = $result;

        // 将解析出来的参数与 $_GET 参数进行合并
        $_GET = array_merge($_GET, $params);

        return [$route, $_GET];
    } else {
        throw new NotFoundHttpException(Yii::t('yii', 'Page not found.'));
    }
}

public function parseRequest($request)
{
    // 启用了 enablePrettyUrl 的情况
    if ($this->enablePrettyUrl) {

        // 获取路径信息
        $pathInfo = $request->getPathInfo();

        // 依次使用所有路由规则来解析当前请求
        // 一旦有一个规则适用，后面的规则就没有被调用的机会了
        foreach ($this->rules as $rule) {
            if (($result = $rule->parseRequest($this, $request)) !== false) {
                return $result;
            }
        }

        // 所有路由规则都不适用，又启用了 enableStrictParsing ，
        // 那只能返回 false  了。
        if ($this->enableStrictParsing) {
            return false;
        }

        // 所有路由规则都不适用，幸好还没启用 enableStrictParing，
        // 那就用默认的解析逻辑

        Yii::trace(
            'No matching URL rules. Using default URL parsing logic.',
            __METHOD__);

        // 配置时所定义的fake suffix，诸如 ".html" 等
        $suffix = (string) $this->suffix;

        if ($suffix !== '' && $pathInfo !== '') {
            // 这个分支的作用在于确保 $pathInfo 不能仅仅是包含一个 ".html"。

            $n = strlen($this->suffix);
            // 留意这个 -$n 的用法
            if (substr_compare($pathInfo, $this->suffix, -$n, $n) === 0) {
                $pathInfo = substr($pathInfo, 0, -$n);

                // 仅包含 ".html" 的$pathInfo要之何用？掐死算了。
                if ($pathInfo === '') {
                    return false;
                }

            // 后缀没匹配上
            } else {
                return false;
            }
        }

        return [$pathInfo, []];

    // 没有启用 enablePrettyUrl的情况，那就更简单了，
    // 直接使用默认的解析逻辑就OK了
    } else {
        Yii::trace(
            'Pretty URL not enabled. Using default URL parsing logic.',
            __METHOD__);
        $route = $request->getQueryParam($this->routeParam, '');
        if (is_array($route)) {
            $route = '';
        }

        return [(string) $route, []];
    }
}