Class yii\web\Request

继承yii\web\Request » yii\base\Request » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/web/Request.php

Web Request 类表示一个 HTTP 请求.

它封装了 $_SERVER 变量并解决了不同 Web 服务器之间的不一致问题. 它还提供了一个接口, 用于检索通过其它 HTTP 方法(例如, PUT 或 DELETE)发送的 $_POST, $_GET, $_COOKIES 和 REST 参数中的请求参数.

默认情况下, Request 在 yii\web\Application 中配置为应用程序组件. 你可以通过Yii::$app->request来访问该实例.

有关 Request 的更多详细信息和使用信息, 请参阅 guide article on requests.

公共属性

隐藏继承的属性

属性类型描述定义在
$absoluteUrl string 当前请求的绝对 URL. 该属性是只读的. yii\web\Request
$acceptableContentTypes array 内容类型按质量得分排序. 分数最高的类型将首先返回. 数组键是内容类型, 而数组值是标题中给出的相应的质量分数和其它参数. yii\web\Request
$acceptableLanguages array 按首选级别(偏好水平)排序的语言. 第一个元素代表最受欢迎的语言. yii\web\Request
$authCredentials array 其中包含两个元素: - 0: 通过 HTTP 身份验证发送的用户名, 如果未提供用户名, 则未null; - 1: 通过 HTTP 身份验证发送的密码, 如果未提供密码, 则未null. 该属性是只读的. yii\web\Request
$authPassword string|null 通过 HTTP 身份验证发送的密码, 如果未提供密码, 则为null. 该属性是只读的. yii\web\Request
$authUser string|null 通过 HTTP 身份验证发送的用户名, 如果未提供用户名, 则未null. 该属性是只读的. yii\web\Request
$baseUrl string 该应用程序的相对 URL. yii\web\Request
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$bodyParams array 在请求主体中给出的请求参数. yii\web\Request
$contentType string 请求内容类型. 如果此信息不可用, 则返回null. 该属性是只读的. yii\web\Request
$cookieValidationKey string 用于 cookie 验证的密钥. yii\web\Request
$cookies yii\web\CookieCollection Cookie 集合. 该属性是只读的. yii\web\Request
$csrfCookie array 用于创建 CSRF cookie 的配置. yii\web\Request
$csrfParam string 用于防止 CSRF 的令牌的名称. yii\web\Request
$csrfToken string 用于执行 CSRF 验证的令牌(token). 该属性是只读的. yii\web\Request
$csrfTokenFromHeader string 浏览器通过 CSRF_HEADER 发送的 CSRF 令牌(token). 如果未发送此类标头, 则返回null. 该属性是只读的. yii\web\Request
$eTags array 实体标签. 该属性是只读的. yii\web\Request
$enableCookieValidation boolean 是否应该验证 cookies 以确保它们不会被篡改. yii\web\Request
$enableCsrfCookie boolean 是否使用 cookie 来保留 CSRF 令牌. yii\web\Request
$enableCsrfValidation boolean 是否启用 CSRF(跨站点请求伪造)验证. yii\web\Request
$headers yii\web\HeaderCollection 标头集合. 该属性是只读的. yii\web\Request
$hostInfo string|null 请求网址(eg. http://www.yiiframework.com) 的模式和主机名部分(如果需要, 还带有端口号), 如果无法从$_SERVER获得并且未设置, 则返回null. 有关此属性的与安全性有关的说明, 请参阅 getHostInfo(). yii\web\Request
$hostName string|null Hostname part of the request URL (e.g. www.yiiframework.com). 该属性是只读的. yii\web\Request
$ipHeaders string[] 代理存储真实客户端IP 的标头列表. yii\web\Request
$isAjax boolean 这是否是一个 AJAX(XMLHttpRequest) 请求. 该属性是只读的. yii\web\Request
$isConsoleRequest boolean 指示当前请求是否是通过控制台发出的. yii\base\Request
$isDelete boolean 这是否是一个 DELETE 请求. 该属性是只读的. yii\web\Request
$isFlash boolean 这是否是一个 Adobe Flash 或 Adobe Flex 请求. 该属性是只读的. yii\web\Request
$isGet boolean 这是否是一个 GET 请求. 该属性是只读的. yii\web\Request
$isHead boolean 这是否是一个 HEAD 请求. 该属性是只读的. yii\web\Request
$isOptions boolean 这是否是一个 OPTIONS 请求. 该属性是只读的. yii\web\Request
$isPatch boolean 这是否是一个 PATCH 请求. 该属性是只读的. yii\web\Request
$isPjax boolean 这是否是一个 PJAX 请求. 该属性是只读的. yii\web\Request
$isPost boolean 这是否是一个 POST 请求. 该属性是只读的. yii\web\Request
$isPut boolean 这是否是一个 PUT 请求. 该属性是只读的. yii\web\Request
$isSecureConnection boolean 如果请求是通过安全通道(https)发送的. 该属性是只读的. yii\web\Request
$method string 请求方法, 如: GET, POST, HEAD, PUT, PATCH, DELETE. 返回的值变成大写. 该属性是只读的. yii\web\Request
$methodParam string POST 参数的名称, 该参数用于指示请求是否是通过 POST 隧道发送的 PUT, PATCH 或 DELETE请求. yii\web\Request
$origin string|null CORS 请求的 URL 来源; 如果不可用, 则为null. 该属性是只读的. yii\web\Request
$parsers array 用于将原始 HTTP 请求主体转换为 $bodyParams 的解析器. yii\web\Request
$pathInfo string 请求 URL 的一部分, 在入口脚本之后和问号之前的. 请注意, 返回的路径信息已被 URL 解码. yii\web\Request
$port integer 不安全请求的端口号. yii\web\Request
$preferredLanguage string 应用程序应使用的语言. yii\web\Request
$queryParams array 请求 GET 参数值. yii\web\Request
$queryString string 问号之后部分的请求 URL. 该属性是只读的. yii\web\Request
$rawBody string 请求主体. yii\web\Request
$referrer string|null URL 引荐来源网址, 如果不可用, 则为null. 该属性是只读的. yii\web\Request
$remoteHost string|null 远程主机名, 如果不可用, 则为null. 该属性是只读的. yii\web\Request
$remoteIP string|null 远程 IP 地址, 如果不可用, 则为null. 该属性是只读的. yii\web\Request
$scriptFile string 入口脚本文件路径. yii\web\Request
$scriptUrl string 入口脚本的相对 URL. yii\web\Request
$secureHeaders array 默认情况下, 受信任的主机配置约束的标头列表. yii\web\Request
$securePort integer 安全请求的端口号. yii\web\Request
$secureProtocolHeaders array 用于确定是否通过 HTTPS 建立连接的标头连接. yii\web\Request
$serverName string 服务器名称, 如果不可用, 则为null. 该属性是只读的. yii\web\Request
$serverPort integer|null 服务器端口号, 如果不可用, 则为null.. 该属性是只读的. yii\web\Request
$trustedHosts array 受信任的安全相关标头的配置. yii\web\Request
$url string 当前请求的相对 URL. 请注意, 根据客户端的不同, 返回的 URI 可能是 URL 编码的. yii\web\Request
$userAgent string|null 用户代理, 如果不可用, 则为null. 该属性是只读的. yii\web\Request
$userHost string|null 用户主机名, 如果不可用, 则为null. 该属性是只读的. yii\web\Request
$userIP string|null 用户 IP 地址, 如果不可用, 则为null. 该属性是只读的. yii\web\Request

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
get() 返回具有给定名称的 GET 参数. 如果未指定名称, 则返回所有 GET 参数的数组. yii\web\Request
getAbsoluteUrl() 返回当前请求的绝对 URL. yii\web\Request
getAcceptableContentTypes() 返回最终用户可接受的内容类型. yii\web\Request
getAcceptableLanguages() 返回最终用户可接受的语言. yii\web\Request
getAuthCredentials() 返回通过 HTTP 身份验证发送的用户名和密码. yii\web\Request
getAuthPassword() 返回通过 HTTP 身份验证发送的密码. yii\web\Request
getAuthUser() 返回通过 HTTP 身份验证发送的用户名. yii\web\Request
getBaseUrl() 返回应用程序的相对 URL. yii\web\Request
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
getBodyParam() 返回指定的请求主体参数值. yii\web\Request
getBodyParams() 返回请求主体中给出的请求参数. yii\web\Request
getContentType() 返回请求内容类型. yii\web\Request
getCookies() 返回 cookie 集合. yii\web\Request
getCsrfToken() 返回用于执行 CSRF 验证的令牌. yii\web\Request
getCsrfTokenFromHeader() 返回浏览器通过 CSRF_HEADER 发送的 CSRF 令牌. yii\web\Request
getETags() 返回实体标签. yii\web\Request
getHeaders() 返回标头集合. yii\web\Request
getHostInfo() 返回当前请求 URL 的模式和主机部分. yii\web\Request
getHostName() 返回当前请求 URL 的主机部分. yii\web\Request
getIsAjax() 返回这是否是一个 AJAX (XMLHttpRequest) 请求. yii\web\Request
getIsConsoleRequest() 返回一个值, 指示当前请求是否是通过命令行发出的. yii\base\Request
getIsDelete() 返回这是否是一个 DELETE 请求. yii\web\Request
getIsFlash() 这是否是一个 Adobe Flash 或 Adobe Flex 请求. yii\web\Request
getIsGet() 返回这是否是一个 GET 请求. yii\web\Request
getIsHead() 返回这是否是一个 HEAD 请求. yii\web\Request
getIsOptions() 返回这是否是一个 OPTIONS 请求. yii\web\Request
getIsPatch() 返回这是否是一个 PATCH 请求. yii\web\Request
getIsPjax() 返回这是否是一个 PJAX请求. yii\web\Request
getIsPost() 返回这是否是一个 POST 请求. yii\web\Request
getIsPut() 返回这是否是一个 PUT 请求. yii\web\Request
getIsSecureConnection() 请求是否是通过安全通道(https)发送的. yii\web\Request
getMethod() 返回当前请求的方法(eg. GET, POST, HEAD, PUT, PATCH, DELETE). yii\web\Request
getOrigin() 返回 CORS 请求的 URL 来源. yii\web\Request
getPathInfo() 返回当前请求的 URL 的路径信息. yii\web\Request
getPort() 返回用于不安全请求的端口号. yii\web\Request
getPreferredLanguage() 返回此应用程序应使用的用户首选语言. yii\web\Request
getQueryParam() 返回指定的 GET 参数值. yii\web\Request
getQueryParams() 返回 $queryString 中给定的请求参数. yii\web\Request
getQueryString() 返回请求 URL 中问号之后的部分. yii\web\Request
getRawBody() 返回原始的 HTTP 请求主体. yii\web\Request
getReferrer() 返回 URL 来源. yii\web\Request
getRemoteHost() 返回此连接另一端的主机名. yii\web\Request
getRemoteIP() 返回此连接另一端的 IP. yii\web\Request
getScriptFile() 返回入口脚本文件路径. yii\web\Request
getScriptUrl() 返回入口脚本的相对 URL. yii\web\Request
getSecurePort() 返回用于安全请求的端口号. yii\web\Request
getServerName() 返回服务器名称. yii\web\Request
getServerPort() 返回服务器端口号. yii\web\Request
getUrl() 返回当前请求的相对 URL. yii\web\Request
getUserAgent() 返回用户代理. yii\web\Request
getUserHost() 返回用户主机名. yii\web\Request
getUserIP() 返回用户 IP 地址. yii\web\Request
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化对象. yii\base\BaseObject
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
parseAcceptHeader() 解析给定的Accept(或Accept-Language)标头. yii\web\Request
post() 返回具有给定名称的 POST 参数. 如果未指定名称, 则返回所有 POST 参数的数组. yii\web\Request
resolve() 将当前请求解析为路由和相关参数. yii\web\Request
setAcceptableContentTypes() 设置可接受的内容类型. yii\web\Request
setAcceptableLanguages() 设置最终用户可接受的语言. yii\web\Request
setBaseUrl() 设置应用程序的相对 URL. yii\web\Request
setBodyParams() 设置请求的主体参数. yii\web\Request
setHostInfo() 设置应用程序 URL 的模式和主机部分. yii\web\Request
setIsConsoleRequest() 设置指示当前请求是否是通过命令行发出的. yii\base\Request
setPathInfo() 设置当前请求的路径信息. yii\web\Request
setPort() 设置用于不安全请求的端口号. yii\web\Request
setQueryParams() 设置请求 $queryString 参数. yii\web\Request
setRawBody() 设置原始的 HTTP 请求主体, 此方法主要由测试脚本用来模拟原始的 HTTP 请求. yii\web\Request
setScriptFile() 设置入口脚本文件路径. yii\web\Request
setScriptUrl() 设置应用程序入口脚本的相对 URL. yii\web\Request
setSecurePort() 设置用于安全请求的端口号. yii\web\Request
setUrl() 设置当前请求的相对 URL. yii\web\Request
trigger() 触发事件. yii\base\Component
validateCsrfToken() 执行 CSRF 验证. yii\web\Request

受保护的方法

隐藏继承的方法

方法描述定义在
createCsrfCookie() 用随机生成的 CSRF 令牌创建一个 cookie. yii\web\Request
filterHeaders() 根据 $trustedHosts 过滤标头. yii\web\Request
generateCsrfToken() 生成用于执行 CSRF 验证的未屏蔽的随机令牌. yii\web\Request
getIpValidator() 创建 yii\validators\IpValidator 的实例. yii\web\Request
getSecureForwardedHeaderParts() 返回解码的转发抱头. yii\web\Request
getSecureForwardedHeaderTrustedPart() 获取令牌的第一个Forwarded(转发)标头值. yii\web\Request
getSecureForwardedHeaderTrustedParts() 仅获取受信任的Forwarded(转发)标头部分. yii\web\Request
getTrustedHeaders() 根据 $trustedHosts 的可信头. yii\web\Request
getUserIpFromIpHeader() 从 IP 标头返回用户 IP. yii\web\Request
getUserIpFromIpHeaders() $ipHeaders 返回用户 IP 地址. yii\web\Request
loadCookies() $_COOKIE转换为 yii\web\Cookie 的数组. yii\web\Request
loadCsrfToken() 从 cookie 或 session 中加载 CSRF 令牌. yii\web\Request
resolvePathInfo() 解析当前请求的 URL 的路径信息部分. yii\web\Request
resolveRequestUri() 解析当前请求的 URL 的请求 URI 部分. yii\web\Request

常量

隐藏继承的常量

常量描述定义在
CSRF_HEADER 'X-CSRF-Token' 发送 CSRF 令牌的 HTTP 标头的名称. yii\web\Request
CSRF_MASK_LENGTH 8 CSRF 令牌掩码的长度. Deprecated 自 2.0.12. 掩码长度现在等于令牌长度. yii\web\Request

属性详情

$absoluteUrl public 属性

当前请求的绝对 URL. 该属性是只读的.

public string $absoluteUrl null
$acceptableContentTypes public 属性

内容类型按质量得分排序. 分数最高的类型将首先返回. 数组键是内容类型, 而数组值是标题中给出的相应的质量分数和其它参数.

$acceptableLanguages public 属性

按首选级别(偏好水平)排序的语言. 第一个元素代表最受欢迎的语言.

$authCredentials public 属性

其中包含两个元素: - 0: 通过 HTTP 身份验证发送的用户名, 如果未提供用户名, 则未null; - 1: 通过 HTTP 身份验证发送的密码, 如果未提供密码, 则未null. 该属性是只读的.

public array $authCredentials null
$authPassword public 属性

通过 HTTP 身份验证发送的密码, 如果未提供密码, 则为null. 该属性是只读的.

public string|null $authPassword null
$authUser public 属性

通过 HTTP 身份验证发送的用户名, 如果未提供用户名, 则未null. 该属性是只读的.

public string|null $authUser null
$baseUrl public 属性

该应用程序的相对 URL.

public string $baseUrl null
$bodyParams public 属性

在请求主体中给出的请求参数.

public array $bodyParams null
$contentType public 属性

请求内容类型. 如果此信息不可用, 则返回null. 该属性是只读的.

public string $contentType null
$cookieValidationKey public 属性

用于 cookie 验证的密钥. 如果 $enableCookieValidationtrue, 则必须设置此属性.

$cookies public 属性

Cookie 集合. 该属性是只读的.

$csrfCookie public 属性

用于创建 CSRF cookie 的配置. 仅当 $enableCsrfValidation$enableCsrfCookie 都为true时才使用此属性.

public array $csrfCookie = ['httpOnly' => true]
$csrfParam public 属性

用于防止 CSRF 的令牌的名称. 默认为_csrf. 仅当 $enableCsrfValidationtrue时才使用此属性.

public string $csrfParam '_csrf'
$csrfToken public 属性

用于执行 CSRF 验证的令牌(token). 该属性是只读的.

public string $csrfToken null
$csrfTokenFromHeader public 属性

浏览器通过 CSRF_HEADER 发送的 CSRF 令牌(token). 如果未发送此类标头, 则返回null. 该属性是只读的.

$eTags public 属性

实体标签. 该属性是只读的.

public array $eTags null
$enableCookieValidation public 属性

是否应该验证 cookies 以确保它们不会被篡改. 默认为true.

$enableCsrfCookie public 属性

是否使用 cookie 来保留 CSRF 令牌. 如果为false, 则 CSRF 令牌将以 $csrfParam 的名称存储在 session 中.

Note: 虽然将 CSRF 令牌存储在 session 中会提高安全性, 但它需要为每个页面一个 session, 这会降低网站性能.

public boolean $enableCsrfCookie true
$enableCsrfValidation public 属性

是否启用 CSRF(跨站点请求伪造)验证. 默认为true. 启用 CSRF 验证后, 提交给 Yii Web 应用程序的表单必须源自同一个应用程序. 否则, 将会引发 HTTP400异常.

Note: 此功能要求用户客户端接受 cookie. 此外, 要使用此功能, 通过 POST 方法提交的表单必须包含一个隐藏的输入, 其名称由 $csrfParam 指定. 你可以使用 yii\helpers\Html::beginForm() 来生成它的隐藏输入.

在 JavaScript 中, 你可以分别通过yii.getCsrfParam()yii.getCsrfToken()获取 $csrfParam$csrfToken 的值. 必须注册 yii\web\YiiAsset 资源. 你还需要使用 yii\helpers\Html::csrfMetaTags() 在页面中包含 CSRF 元标记(meta).

参见:

$headers public 属性

标头集合. 该属性是只读的.

$hostInfo public 属性

请求网址(eg. http://www.yiiframework.com) 的模式和主机名部分(如果需要, 还带有端口号), 如果无法从$_SERVER获得并且未设置, 则返回null. 有关此属性的与安全性有关的说明, 请参阅 getHostInfo().

public string|null $hostInfo null
$hostName public 属性

Hostname part of the request URL (e.g. www.yiiframework.com). 该属性是只读的.

public string|null $hostName null
$ipHeaders public 属性 (可用自版本: 2.0.13)

代理存储真实客户端IP 的标头列表. 不建议在此处放置不安全的标头. 要根据 RFC 7239 使用Forwarded(转发)标头, 必须将标头添加到 $secureHeaders 列表中. 标头名称的匹配不区分大小写.

参见:

public string[] $ipHeaders = ['X-Forwarded-For']
$isAjax public 属性

这是否是一个 AJAX(XMLHttpRequest) 请求. 该属性是只读的.

public boolean $isAjax null
$isDelete public 属性

这是否是一个 DELETE 请求. 该属性是只读的.

public boolean $isDelete null
$isFlash public 属性

这是否是一个 Adobe Flash 或 Adobe Flex 请求. 该属性是只读的.

public boolean $isFlash null
$isGet public 属性

这是否是一个 GET 请求. 该属性是只读的.

public boolean $isGet null
$isHead public 属性

这是否是一个 HEAD 请求. 该属性是只读的.

public boolean $isHead null
$isOptions public 属性

这是否是一个 OPTIONS 请求. 该属性是只读的.

public boolean $isOptions null
$isPatch public 属性

这是否是一个 PATCH 请求. 该属性是只读的.

public boolean $isPatch null
$isPjax public 属性

这是否是一个 PJAX 请求. 该属性是只读的.

public boolean $isPjax null
$isPost public 属性

这是否是一个 POST 请求. 该属性是只读的.

public boolean $isPost null
$isPut public 属性

这是否是一个 PUT 请求. 该属性是只读的.

public boolean $isPut null
$isSecureConnection public 属性

如果请求是通过安全通道(https)发送的. 该属性是只读的.

$method public 属性

请求方法, 如: GET, POST, HEAD, PUT, PATCH, DELETE. 返回的值变成大写. 该属性是只读的.

public string $method null
$methodParam public 属性

POST 参数的名称, 该参数用于指示请求是否是通过 POST 隧道发送的 PUT, PATCH 或 DELETE请求. 默认为_method.

参见:

public string $methodParam '_method'
$origin public 属性

CORS 请求的 URL 来源; 如果不可用, 则为null. 该属性是只读的.

public string|null $origin null
$parsers public 属性

用于将原始 HTTP 请求主体转换为 $bodyParams 的解析器. 数组键是请求Content-Types, 数组值是 创建解析器对象 的相应配置. 解析器必须实现 yii\web\RequestParserInterface.

要启用对 JSON 请求的解析, 可以使用 yii\web\JsonParser 类, 如下例所示:

[
    'application/json' => 'yii\web\JsonParser',
]

要注册用于解析所有请求类型的解析器, 可以使用*作为数组键. 如果没有其它类型匹配, 则将其用作备用.

参见 getBodyParams().

public array $parsers = []
$pathInfo public 属性

请求 URL 的一部分, 在入口脚本之后和问号之前的. 请注意, 返回的路径信息已被 URL 解码.

public string $pathInfo null
$port public 属性

不安全请求的端口号.

public integer $port null
$preferredLanguage public 只读 属性

应用程序应使用的语言.

public string getPreferredLanguage ( array $languages = [] )
$queryParams public 属性

请求 GET 参数值.

public array $queryParams null
$queryString public 属性

问号之后部分的请求 URL. 该属性是只读的.

public string $queryString null
$rawBody public 属性

请求主体.

public string $rawBody null
$referrer public 属性

URL 引荐来源网址, 如果不可用, 则为null. 该属性是只读的.

public string|null $referrer null
$remoteHost public 属性

远程主机名, 如果不可用, 则为null. 该属性是只读的.

public string|null $remoteHost null
$remoteIP public 属性

远程 IP 地址, 如果不可用, 则为null. 该属性是只读的.

public string|null $remoteIP null
$scriptFile public 属性

入口脚本文件路径.

public string $scriptFile null
$scriptUrl public 属性

入口脚本的相对 URL.

public string $scriptUrl null
$secureHeaders public 属性 (可用自版本: 2.0.13)

默认情况下, 受信任的主机配置约束的标头列表. 除非在 $trustedHosts 中明确允许, 否则将过滤这些标头. 如果列表中包含Forwarded(转发)标头, 则根据 RFC 7239 进行处理. 标头名称的匹配不分区大小写.

参见:

public array $secureHeaders = ['X-Forwarded-For''X-Forwarded-Host''X-Forwarded-Proto''Front-End-Https''X-Rewrite-Url']
$securePort public 属性

安全请求的端口号.

public integer $securePort null
$secureProtocolHeaders public 属性 (可用自版本: 2.0.13)

用于确定是否通过 HTTPS 建立连接的标头连接. 数组键是标头名称, 数组值是指示建立安全连接的标头值的列表. 标头名称和值的匹配不区分大小写. 不建议在此处放置不安全的标头.

参见:

public array $secureProtocolHeaders = ['X-Forwarded-Proto' => ['https'], 'Front-End-Https' => ['on']]
$serverName public 属性

服务器名称, 如果不可用, 则为null. 该属性是只读的.

public string $serverName null
$serverPort public 属性

服务器端口号, 如果不可用, 则为null.. 该属性是只读的.

public integer|null $serverPort null
$trustedHosts public 属性 (可用自版本: 2.0.13)

受信任的安全相关标头的配置.

数组键是 CIDR 表示法中的 IPv4 或 IPv6 IP 地址, 用于匹配客户端.

数组值是要信任的标头列表, 这些将与 $secureHeaders 匹配, 以确定允许指定主机发送的标头. 标头名称的大小写必须与 $secureHeaders 中指定的相同.

例如, 要信任 $secureHeaders 中列出的 IP 地址在192.168.0.0-192.168.0.254返回内的所有标头, 请输入以下内容:

[
    '192.168.0.0/24',
]

要仅信任10.0.0.1中的X-Forwarded-For标头, 请使用:

[
    '10.0.0.1' => ['X-Forwarded-For']
]

默认是从所有主机信任除 $secureHeaders 中列出的标头之外的所有标头. IP 匹配时, 顺序尝试匹配, 并停止搜索.

Info: 使用 yii\validators\IpValidator 进行匹配.

有关高级匹配, 请参阅: IpValidator::::setRanges()yii\validators\IpValidator::$networks.

参见 $secureHeaders.

public array $trustedHosts = []
$url public 属性

当前请求的相对 URL. 请注意, 根据客户端的不同, 返回的 URI 可能是 URL 编码的.

public string $url null
$userAgent public 属性

用户代理, 如果不可用, 则为null. 该属性是只读的.

public string|null $userAgent null
$userHost public 属性

用户主机名, 如果不可用, 则为null. 该属性是只读的.

public string|null $userHost null
$userIP public 属性

用户 IP 地址, 如果不可用, 则为null. 该属性是只读的.

public string|null $userIP null

方法详情

createCsrfCookie() protected 方法

用随机生成的 CSRF 令牌创建一个 cookie.

$csrfCookie 中指定的初始值将应用于生成的 cookie.

参见 $enableCsrfValidation.

protected yii\web\Cookie createCsrfCookie ( $token )
$token string

CSRF 令牌.

return yii\web\Cookie

生成的 cookie.

filterHeaders() protected 方法 (可用自版本: 2.0.13)

根据 $trustedHosts 过滤标头.

protected void filterHeaders ( yii\web\HeaderCollection $headerCollection )
$headerCollection yii\web\HeaderCollection
generateCsrfToken() protected 方法

生成用于执行 CSRF 验证的未屏蔽的随机令牌.

protected string generateCsrfToken ( )
return string

CSRF 验证的随机令牌.

get() public 方法

返回具有给定名称的 GET 参数. 如果未指定名称, 则返回所有 GET 参数的数组.

public array|mixed get ( $name null, $defaultValue null )
$name string

参数名称.

$defaultValue mixed

如果参数不存在, 则为默认参数值.

getAbsoluteUrl() public 方法

返回当前请求的绝对 URL.

这是 $hostInfo$url 串联的快捷方式.

public string getAbsoluteUrl ( )
return string

当前请求的绝对 URL.

getAcceptableContentTypes() public 方法

返回最终用户可接受的内容类型.

这由 Accept HTTP 标头来确定. 例如:

$_SERVER['HTTP_ACCEPT'] = 'text/plain; q=0.5, application/json; version=1.0, application/xml; version=2.0;';
$types = $request->getAcceptableContentTypes();
print_r($types);
// 显示:
// [
//     'application/json' => ['q' => 1, 'version' => '1.0'],
//      'application/xml' => ['q' => 1, 'version' => '2.0'],
//           'text/plain' => ['q' => 0.5],
// ]
public array getAcceptableContentTypes ( )
return array

按质量分数排序的内容类型. 分数最高的类型将首先返回. 数组键是内容类型, 而数组值是相应的质量分数和其它参数.

getAcceptableLanguages() public 方法

返回最终用户可接受的语言.

这是由 HTTP Accept-Language标头确定的.

public array getAcceptableLanguages ( )
return array

按偏好级别排序的语言. 第一个元素代表最受欢迎的语言.

getAuthCredentials() public 方法 (可用自版本: 2.0.13)

返回通过 HTTP 身份验证发送的用户名和密码.

参见:

public array getAuthCredentials ( )
return array

包含两个元素:

  • 0: 通过 HTTP 身份验证发送的用户名, 如果未提供用户名, 则未null.
  • 1: 通过 HTTP 身份验证发送的密码, 如果未提供密码, 则未null.
getAuthPassword() public 方法

返回通过 HTTP 身份验证发送的密码.

参见 getAuthCredentials() 获取用户名和密码.

public string|null getAuthPassword ( )
return string|null

通过 HTTP 身份验证发送的密码, 如果未提供密码, 则未null.

getAuthUser() public 方法

返回通过 HTTP 身份验证发送的用户名.

参见 getAuthCredentials() 获取用户名和密码.

public string|null getAuthUser ( )
return string|null

通过 HTTP 身份验证发送的用户名, 如果未提供用户名, 则未null.

getBaseUrl() public 方法

返回应用程序的相对 URL.

这与 $scriptUrl 类似, 只是它不包含脚本文件名, 并且结尾的斜杠被删除.

参见 setScriptUrl().

public string getBaseUrl ( )
return string

该应用程序的相对 URL.

getBodyParam() public 方法

返回指定的请求主体参数值.

如果参数不存在, 则返回传递给此方法的第二个参数.

参见:

public mixed getBodyParam ( $name, $defaultValue null )
$name string

参数名称.

$defaultValue mixed

如果参数不存在, 则为默认参数值.

return mixed

参数值.

getBodyParams() public 方法

返回请求主体中给出的请求参数.

使用 $parsers 属性中配置的解析器确定请求参数. 如果没有为当前 $contentType 配置任何解析器, 它将使用 PHP 函数mb_parse_str()来解析 请求主体.

参见:

public array getBodyParams ( )
return array

请求主体中给出的请求参数.

throws yii\base\InvalidConfigException

如果注册的解析器未实现 yii\web\RequestParserInterface.

getContentType() public 方法

返回请求内容类型.

Content-Type 标头字段表示 getRawBody() 中包含的数据的 MIME 类型, 对于 HEAD 方法, 如果请求是 GET, 则将发送的媒体类型. 有关用户期望作为响应的的 MIME 类型, 请参阅 $acceptableContentTypes.

public string getContentType ( )
return string

请求内容类型. 如果此信息不可用, 则返回null.

getCookies() public 方法

返回 cookie 集合.

通过返回的 cookie 集合, 你可以使用以下语法访问 cookie:

$cookie = $request->cookies['name']
if ($cookie !== null) {
    $value = $cookie->value;
}

// 或者
$value = $request->cookies->getValue('name');
public yii\web\CookieCollection getCookies ( )
return yii\web\CookieCollection

Cookie 集合.

getCsrfToken() public 方法

返回用于执行 CSRF 验证的令牌.

生成此令牌的方式可以防止 BREACH 攻击. 它可以通过 HTML 表单的隐藏字段或 HTTP 标头值传递, 以支持 CSRF 验证.

public string getCsrfToken ( $regenerate false )
$regenerate boolean

是否重新生成 CSRF 令牌. 如果此参数为true, 则每次调用此方法时, 都会生成一个新的 CSRF 令牌并将其保留在 session 或 cookie 中.

return string

用于执行 CSRF 验证的令牌.

getCsrfTokenFromHeader() public 方法

返回浏览器通过 CSRF_HEADER 发送的 CSRF 令牌.

public string getCsrfTokenFromHeader ( )
return string

浏览器通过 CSRF_HEADER 发送的 CSRF 令牌. 如果未发送此类标头, 则返回null.

getETags() public 方法

返回实体标签.

public array getETags ( )
return array

实体标签.

getHeaders() public 方法

返回标头集合.

标头集合包含传入的 HTTP 标头.

public yii\web\HeaderCollection getHeaders ( )
return yii\web\HeaderCollection

标头集合.

getHostInfo() public 方法

返回当前请求 URL 的模式和主机部分.

返回的 URL 没有结尾的斜杠.

默认情况下, 此值基于用户请求信息. 如果可用, 该方法将返回$_SERVER['HTTP_HOST']的值, 否则返回$_SERVER['SERVER_NAME']的值. 你可能想查看 PHP 文档 获取更多关于这些变量的信息.

Warning: 根据服务器配置, 此信息可能不可靠, 并且可能会被发送 HTTP 请求的用户伪造. 如果将 Web 服务器配置为与Host标头的值无关地为同一站点提供服务, 则此值不可靠. 在这种情况下, 你应该修复你的 Web 服务器配置, 或通过设置 hostInfo 属性来显式设置该值. 如果你无权访问服务器配置, 则可以在应用程序级别设置 yii\filters\HostControl 过滤器, 以防止此类攻击.

参见 setHostInfo().

public string|null getHostInfo ( )
return string|null

请求 URL(eg. http://www.yiiframework.com) 的模式和主机名部分(如果需要, 还带有端口号), 如果无法从$_SERVER获得并且未设置, 则返回null.

getHostName() public 方法 (可用自版本: 2.0.10)

返回当前请求 URL 的主机部分.

值是根据当前 hostInfo 属性计算的.

Warning: 此值的内容可能不可靠, 具体取决于服务器配置. 有关更多信息, 请参阅 getHostInfo().

参见 getHostInfo().

public string|null getHostName ( )
return string|null

请求 URL 的主机名部分(eg. www.yiiframework.com)

getIpValidator() protected 方法 (可用自版本: 2.0.13)

创建 yii\validators\IpValidator 的实例.

你可以重写此方法以调整验证器或实施其它匹配策略.

protected yii\validators\IpValidator getIpValidator ( )
getIsAjax() public 方法

返回这是否是一个 AJAX (XMLHttpRequest) 请求.

Note: 在跨域请求的情况下, 浏览器默认不会设置 X-Requested-With: https://stackoverflow.com/questions/8163703/cross-domain-ajax-doesnt-send-x-requested-with-header

如果你使用 fetch(), 请手动传递标头:

fetch(url, {
   method: 'GET',
   headers: {'X-Requested-With': 'XMLHttpRequest'}
})
public boolean getIsAjax ( )
return boolean

这是否是一个 AJAX (XMLHttpRequest) 请求.

getIsDelete() public 方法

返回这是否是一个 DELETE 请求.

public boolean getIsDelete ( )
return boolean

这是否是一个 DELETE 请求.

getIsFlash() public 方法

这是否是一个 Adobe Flash 或 Adobe Flex 请求.

public boolean getIsFlash ( )
return boolean

返回这是否是一个 Adobe Flash 或 Adobe Flex 请求.

getIsGet() public 方法

返回这是否是一个 GET 请求.

public boolean getIsGet ( )
return boolean

这是否是一个 GET 请求.

getIsHead() public 方法

返回这是否是一个 HEAD 请求.

public boolean getIsHead ( )
return boolean

这是否是一个 HEAD 请求.

getIsOptions() public 方法

返回这是否是一个 OPTIONS 请求.

public boolean getIsOptions ( )
return boolean

这是否是一个 OPTIONS 请求.

getIsPatch() public 方法

返回这是否是一个 PATCH 请求.

public boolean getIsPatch ( )
return boolean

这是否是一个 PATCH 请求.

getIsPjax() public 方法

返回这是否是一个 PJAX请求.

public boolean getIsPjax ( )
return boolean

这是否是一个 PJAX请求.

getIsPost() public 方法

返回这是否是一个 POST 请求.

public boolean getIsPost ( )
return boolean

这是否是一个 POST 请求.

getIsPut() public 方法

返回这是否是一个 PUT 请求.

public boolean getIsPut ( )
return boolean

这是否是一个 PUT 请求.

getIsSecureConnection() public 方法

请求是否是通过安全通道(https)发送的.

public boolean getIsSecureConnection ( )
return boolean

如果请求是通过安全通道(https)发送的.

getMethod() public 方法

返回当前请求的方法(eg. GET, POST, HEAD, PUT, PATCH, DELETE).

public string getMethod ( )
return string

请求方法, 例如 GET, POST, HEAD, PUT, PATCH, DELETE. 返回的值变成大写.

getOrigin() public 方法 (可用自版本: 2.0.13)

返回 CORS 请求的 URL 来源.

返回值取自浏览器发送的Origin header.

Note: 原始请求标头指示提取的来源. 它不包含任何路径信息, 而仅包含服务器名称. 它与 CORS 请求以及 POST 请求一起发送. 它与引荐来源标头相似, 但是与标头不同, 它没有披露完整路径. 有关更多信息, 请参阅 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin.

参见 getHeaders().

public string|null getOrigin ( )
return string|null

CORS 请求的 URL 来源, 如果不可用, 则为null.

getPathInfo() public 方法

返回当前请求的 URL 的路径信息.

路径信息是指在入口脚本之后和问号(查询字符串)之前的部分. 起始和结束斜杠都被删除.

public string getPathInfo ( )
return string

请求 URL 中位于入口脚本之后和问号之前的部分.

Note: 返回的路径信息已被解码.

throws yii\base\InvalidConfigException

如果由于意外的服务器配置而无法确定路径信息.

getPort() public 方法

返回用于不安全请求的端口号.

默认为80, 如果当前请求是不安全的, 则为服务器指定的端口号.

参见 setPort().

public integer getPort ( )
return integer

不安全请求的端口号.

getPreferredLanguage() public 方法

返回此应用程序应使用的用户首选语言.

语言解析基于用户首选语言和应用程序支持的语言. 该方法将尝试找到最佳匹配.

public string getPreferredLanguage ( array $languages = [] )
$languages array

应用程序支持的语言列表. 如果为空, 则将返回当前应用程序语言. 而无需进一步处理.

return string

应用程序应使用的语言.

getQueryParam() public 方法

返回指定的 GET 参数值.

如果 GET 参数不存在, 则返回传递给此方法的第二个参数.

参见 getBodyParam().

public mixed getQueryParam ( $name, $defaultValue null )
$name string

GET 参数名称.

$defaultValue mixed

如果 GET 参数不存在, 则为默认参数值.

return mixed

GET 参数值.

getQueryParams() public 方法

返回 $queryString 中给定的请求参数.

如果未明确设置参数, 则此方法将返回$_GET的内容.

参见 setQueryParams().

public array getQueryParams ( )
return array

GET 请求的参数值.

getQueryString() public 方法

返回请求 URL 中问号之后的部分.

public string getQueryString ( )
return string

请求 URL 中问号之后的部分.

getRawBody() public 方法

返回原始的 HTTP 请求主体.

public string getRawBody ( )
return string

请求主体.

getReferrer() public 方法

返回 URL 来源.

public string|null getReferrer ( )
return string|null

URL 来源, 如果不可用, 则为null.

getRemoteHost() public 方法 (可用自版本: 2.0.13)

返回此连接另一端的主机名.

这始终时下一跳, 所有标头都将被忽略.

参见:

public string|null getRemoteHost ( )
return string|null

远程主机名, 如果不可用, 则为null

getRemoteIP() public 方法 (可用自版本: 2.0.13)

返回此连接另一端的 IP.

这始终时下一跳, 所有标头都将被忽略.

public string|null getRemoteIP ( )
return string|null

远程 IP 地址, 如果不可用, 则为null.

getScriptFile() public 方法

返回入口脚本文件路径.

默认实现将只返回$_SERVER['SCRIPT_FILENAME'].

public string getScriptFile ( )
return string

入口脚本文件路径.

throws yii\base\InvalidConfigException
getScriptUrl() public 方法

返回入口脚本的相对 URL.

该方法的实现在 Zend Framework 中引用了 Zend_Controller_Request_Http.

public string getScriptUrl ( )
return string

入口脚本的相对 URL.

throws yii\base\InvalidConfigException

如果无法确定入口脚本的 URL.

getSecureForwardedHeaderParts() protected 方法 (可用自版本: 2.0.31)

返回解码的转发抱头.

protected array getSecureForwardedHeaderParts ( )
getSecureForwardedHeaderTrustedPart() protected 方法 (可用自版本: 2.0.31)

获取令牌的第一个Forwarded(转发)标头值.

protected string|null getSecureForwardedHeaderTrustedPart ( $token )
$token string

标头令牌.

getSecureForwardedHeaderTrustedParts() protected 方法 (可用自版本: 2.0.31)

仅获取受信任的Forwarded(转发)标头部分.

protected array getSecureForwardedHeaderTrustedParts ( )
getSecurePort() public 方法

返回用于安全请求的端口号.

默认为443, 如果当前请求是安全的, 则为服务器指定的端口号.

参见 setSecurePort().

public integer getSecurePort ( )
return integer

安全请求的端口号.

getServerName() public 方法

返回服务器名称.

public string getServerName ( )
return string

服务器名称, 如果不可用, 则为null.

getServerPort() public 方法

返回服务器端口号.

public integer|null getServerPort ( )
return integer|null

服务器端口号, 如果不可用, 则为null.

getTrustedHeaders() protected 方法 (可用自版本: 2.0.28)

根据 $trustedHosts 的可信头.

protected array getTrustedHeaders ( )
getUrl() public 方法

返回当前请求的相对 URL.

这是指 URL 中 $hostInfo 部分之后的部分. 它包括 $queryString 部分(如果有的话).

public string getUrl ( )
return string

当前请求的相对 URL. 请注意, 根据客户端的不同, 返回的 URI 可能会进行 URL 编码.

throws yii\base\InvalidConfigException

如果由于服务器配置异常而无法确定请求 URL.

getUserAgent() public 方法

返回用户代理.

public string|null getUserAgent ( )
return string|null

用户代理, 如果不可用, 则为null.

getUserHost() public 方法

返回用户主机名.

使用标头和/或$_SERVER变量确定 HOST.

public string|null getUserHost ( )
return string|null

用户主机名, 如果不可用, 则为null.

getUserIP() public 方法

返回用户 IP 地址.

使用标头和/或$_SERVER变量确定 IP.

public string|null getUserIP ( )
return string|null

用户 IP 地址, 如果不可用, 则为null.

getUserIpFromIpHeader() protected 方法 (可用自版本: 2.0.28)

从 IP 标头返回用户 IP.

参见:

  • $getUserHost
  • $ipHeader
  • $trustedHeaders
protected string|null getUserIpFromIpHeader ( $ips )
$ips string

逗号分割的 IP 列表.

return string|null

IP 作为字符串. 如果无法从头确定IP, 则返回null.

getUserIpFromIpHeaders() protected 方法 (可用自版本: 2.0.28)

$ipHeaders 返回用户 IP 地址.

参见 $ipHeaders.

protected string|null getUserIpFromIpHeaders ( )
return string|null

用户 IP 地址, 如果不可用, 则为null.

loadCookies() protected 方法

$_COOKIE转换为 yii\web\Cookie 的数组.

protected array loadCookies ( )
return array

从请求中获得的 cookies.

throws yii\base\InvalidConfigException

如果 $enableCookieValidationtrue时未设置 $cookieValidationKey.

loadCsrfToken() protected 方法

从 cookie 或 session 中加载 CSRF 令牌.

protected string loadCsrfToken ( )
return string

从 cookie 或 session 加载的 CSRF 令牌. 如果 cookie 或 session 没有 CSRF 令牌, 则返回null.

parseAcceptHeader() public 方法

解析给定的Accept(或Accept-Language)标头.

该方法将返回可接受的值及其质量分数和给定的Accept标头中指定的相应参数. 返回值的数组键是可接受的值, 而数组值则由相应的质量分数和参数组成. 具有最高质量分数的可接受值将首先返回. 例如:

$header = 'text/plain; q=0.5, application/json; version=1.0, application/xml; version=2.0;';
$accepts = $request->parseAcceptHeader($header);
print_r($accepts);
// 显示:
// [
//     'application/json' => ['q' => 1, 'version' => '1.0'],
//      'application/xml' => ['q' => 1, 'version' => '2.0'],
//           'text/plain' => ['q' => 0.5],
// ]
public array parseAcceptHeader ( $header )
$header string

要解析的标头.

return array

按质量得分排序的可接受值. 分数最高的值将首先返回.

post() public 方法

返回具有给定名称的 POST 参数. 如果未指定名称, 则返回所有 POST 参数的数组.

public array|mixed post ( $name null, $defaultValue null )
$name string

参数名称.

$defaultValue mixed

如果参数不存在, 则为默认参数值.

resolve() public 方法

将当前请求解析为路由和相关参数.

public array resolve ( )
return array

第一个元素是路由, 第二个元素是关联的参数.

throws yii\web\NotFoundHttpException

如果请求无法解析.

resolvePathInfo() protected 方法

解析当前请求的 URL 的路径信息部分.

路径信息是指在入口脚本之后和问号(查询字符串)之前的部分. 开始的斜杠都被删除(结束斜线将被保留).

protected string resolvePathInfo ( )
return string

请求 URL 中位于入口脚本之后和问号之前的部分.

Note: 返回的路径信息已被解码.

throws yii\base\InvalidConfigException

如果由于意外的服务器配置而无法确定路径信息.

resolveRequestUri() protected 方法

解析当前请求的 URL 的请求 URI 部分.

这是指 $hostInfo 部分之后的部分. 它包括 $queryString 部分(如果有的话). 该方法的实现在 Zend Framework 中引用了 Zend_Controller_Request_Http.

protected string|boolean resolveRequestUri ( )
return string|boolean

当前请求的 URL 的请求 URI 部分.

Note: 根据客户端不同, 返回的 URI 可能会进行 URL 编码.

throws yii\base\InvalidConfigException

如果由于服务器配置异常而无法确定请求 URI.

setAcceptableContentTypes() public 方法

设置可接受的内容类型.

参数的格式请参考 getAcceptableContentTypes().

参见:

public void setAcceptableContentTypes ( $value )
$value array

最终用户可接受的内容类型. 他们应按照偏好级别进行排序.

setAcceptableLanguages() public 方法

设置最终用户可接受的语言.

public void setAcceptableLanguages ( $value )
$value array

最终用户可接受的语言. 他们应按照偏好级别进行排序.

setBaseUrl() public 方法

设置应用程序的相对 URL.

默认情况下, URL 是根据入口脚本 URL 确定的. 如果你想改变此行为, 将提供此设置程序.

public void setBaseUrl ( $value )
$value string

该应用程序的相对 URL.

setBodyParams() public 方法

设置请求的主体参数.

参见:

public void setBodyParams ( $values )
$values array

请求主体参数(name-value 对).

setHostInfo() public 方法

设置应用程序 URL 的模式和主机部分.

如果无法在某些 Web 服务器上确定模式和主机名, 则提供此设置程序.

参见 getHostInfo() 有关此属性的安全性注意实现.

public void setHostInfo ( $value )
$value string|null

应用程序 URL 的模式和主机部分. 尾部的斜杠将被删除.

setPathInfo() public 方法

设置当前请求的路径信息.

此方法主要用于测试目的.

public void setPathInfo ( $value )
$value string

当前请求的路径信息.

setPort() public 方法

设置用于不安全请求的端口号.

提供此 setter 是为了某些服务器配置需要自定义端口号.

public void setPort ( $value )
$value integer

端口号.

setQueryParams() public 方法

设置请求 $queryString 参数.

参见:

public void setQueryParams ( $values )
$values array

请求查询参数(name-value 对).

setRawBody() public 方法

设置原始的 HTTP 请求主体, 此方法主要由测试脚本用来模拟原始的 HTTP 请求.

public void setRawBody ( $rawBody )
$rawBody string

请求主体.

setScriptFile() public 方法

设置入口脚本文件路径.

入口脚本文件路径通常可以从$_SERVER['SCRIPT_FILENAME']获得. 如果你的服务器配置未返回正确的值, 则可以配置此属性使其正确.

public void setScriptFile ( $value )
$value string

入口脚本文件路径.

setScriptUrl() public 方法

设置应用程序入口脚本的相对 URL.

如果无法在某些 Web 服务器上确定入口脚本的 URL, 则提供此设置程序.

public void setScriptUrl ( $value )
$value string

应用程序入口脚本的相对 URL.

setSecurePort() public 方法

设置用于安全请求的端口号.

提供此 setter 是为了某些服务器配置需要自定义端口号.

public void setSecurePort ( $value )
$value integer

端口号.

setUrl() public 方法

设置当前请求的相对 URL.

URI 必须引用 $hostInfo 之后的部分.

Note: URI 应该是 URL 编码的.

public void setUrl ( $value )
$value string

要设置的请求 URI.

validateCsrfToken() public 方法

执行 CSRF 验证.

此方法将通过将用户提供的 CSRF 令牌与存储在 cookie 或 session 中的 CSRF 令牌进行比较, 从而验证该令牌. 此方法主要在 yii\web\Controller::beforeAction() 中调用.

Note: 如果 $enableCsrfValidationfalse或 HTTP 方法是 GET, HEAD 或 OPTIONS, 该方法将不执行 CSRF 验证.

public boolean validateCsrfToken ( $clientSuppliedToken null )
$clientSuppliedToken string

用户提供的要验证的 CSRF令牌. 如果为null,则将从 $csrfParam POST 字段或 HTTP 标头中检索令牌. 从版本2.0.4开始, 此参数可用.

return boolean

CSRF 令牌是否有效. 如果 $enableCsrfValidationfalse, 则此方法将返回true.