继承yii\web\Request » yii\base\Request » yii\base\Component » yii\base\Object
可用自版本2.0

The web Request class represents an HTTP request

It encapsulates the $_SERVER variable and resolves its inconsistency among different Web servers. Also it provides an interface to retrieve request parameters from $_POST, $_GET, $_COOKIES and REST parameters sent via other HTTP methods like PUT or DELETE.

Request is configured as an application component in yii\web\Application by default. You can access that instance via Yii::$app->request.

For more details and usage information on Request, see the guide article on requests.

公共属性

隐藏继承属性

属性类型描述定义在
$cookieValidationKey string A secret key used for cookie validation. yii\web\Request
$csrfCookie array The configuration for creating the CSRF cookie. yii\web\Request
$csrfParam string The name of the token used to prevent CSRF. yii\web\Request
$enableCookieValidation boolean Whether cookies should be validated to ensure they are not tampered. yii\web\Request
$enableCsrfCookie boolean Whether to use cookie to persist CSRF token. yii\web\Request
$enableCsrfValidation boolean Whether to enable CSRF (Cross-Site Request Forgery) validation. yii\web\Request
$methodParam string The name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE request tunneled through POST. yii\web\Request
$parsers array The parsers for converting the raw HTTP request body into \yii\web\bodyParams. yii\web\Request

公共方法

隐藏继承方法

方法描述定义在
get() Returns GET parameter with a given name. If name isn't specified, returns an array of all GET parameters. yii\web\Request
getAbsoluteUrl() Returns the currently requested absolute URL. yii\web\Request
getAcceptableContentTypes() Returns the content types acceptable by the end user. yii\web\Request
getAcceptableLanguages() Returns the languages acceptable by the end user. yii\web\Request
getAuthPassword() yii\web\Request
getAuthUser() yii\web\Request
getBaseUrl() Returns the relative URL for the application. yii\web\Request
getBodyParam() Returns the named request body parameter value. yii\web\Request
getBodyParams() Returns the request parameters given in the request body. yii\web\Request
getContentType() Returns request content-type The Content-Type header field indicates the MIME type of the data contained in getRawBody() or, in the case of the HEAD method, the media type that would have been sent had the request been a GET. yii\web\Request
getCookies() Returns the cookie collection. yii\web\Request
getCsrfToken() Returns the token used to perform CSRF validation. yii\web\Request
getCsrfTokenFromHeader() yii\web\Request
getETags() Gets the Etags. yii\web\Request
getHeaders() Returns the header collection. yii\web\Request
getHostInfo() Returns the schema and host part of the current request URL. yii\web\Request
getHostName() Returns the host part of the current request URL. yii\web\Request
getIsAjax() Returns whether this is an AJAX (XMLHttpRequest) request. yii\web\Request
getIsDelete() Returns whether this is a DELETE request. yii\web\Request
getIsFlash() Returns whether this is an Adobe Flash or Flex request. yii\web\Request
getIsGet() Returns whether this is a GET request. yii\web\Request
getIsHead() Returns whether this is a HEAD request. yii\web\Request
getIsOptions() Returns whether this is an OPTIONS request. yii\web\Request
getIsPatch() Returns whether this is a PATCH request. yii\web\Request
getIsPjax() Returns whether this is a PJAX request yii\web\Request
getIsPost() Returns whether this is a POST request. yii\web\Request
getIsPut() Returns whether this is a PUT request. yii\web\Request
getIsSecureConnection() Return if the request is sent via secure channel (https). yii\web\Request
getMethod() Returns the method of the current request (e.g. GET, POST, HEAD, PUT, PATCH, DELETE). yii\web\Request
getPathInfo() Returns the path info of the currently requested URL. yii\web\Request
getPort() Returns the port to use for insecure requests. yii\web\Request
getPreferredLanguage() Returns the user-preferred language that should be used by this application. yii\web\Request
getQueryParam() Returns the named GET parameter value. yii\web\Request
getQueryParams() Returns the request parameters given in the \yii\web\queryString. yii\web\Request
getQueryString() Returns part of the request URL that is after the question mark. yii\web\Request
getRawBody() Returns the raw HTTP request body. yii\web\Request
getReferrer() Returns the URL referrer. yii\web\Request
getScriptFile() Returns the entry script file path. yii\web\Request
getScriptUrl() Returns the relative URL of the entry script. yii\web\Request
getSecurePort() Returns the port to use for secure requests. yii\web\Request
getServerName() Returns the server name. yii\web\Request
getServerPort() Returns the server port number. yii\web\Request
getUrl() Returns the currently requested relative URL. yii\web\Request
getUserAgent() Returns the user agent. yii\web\Request
getUserHost() Returns the user host name. yii\web\Request
getUserIP() Returns the user IP address. yii\web\Request
parseAcceptHeader() Parses the given Accept (or Accept-Language) header. yii\web\Request
post() Returns POST parameter with a given name. If name isn't specified, returns an array of all POST parameters. yii\web\Request
resolve() Resolves the current request into a route and the associated parameters. yii\web\Request
setAcceptableContentTypes() Sets the acceptable content types. yii\web\Request
setAcceptableLanguages() yii\web\Request
setBaseUrl() Sets the relative URL for the application. yii\web\Request
setBodyParams() Sets the request body parameters. yii\web\Request
setHostInfo() Sets the schema and host part of the application URL. yii\web\Request
setPathInfo() Sets the path info of the current request. yii\web\Request
setPort() Sets the port to use for insecure requests. yii\web\Request
setQueryParams() Sets the request \yii\web\queryString parameters. yii\web\Request
setRawBody() Sets the raw HTTP request body, this method is mainly used by test scripts to simulate raw HTTP requests. yii\web\Request
setScriptFile() Sets the entry script file path. yii\web\Request
setScriptUrl() Sets the relative URL for the application entry script. yii\web\Request
setSecurePort() Sets the port to use for secure requests. yii\web\Request
setUrl() Sets the currently requested relative URL. yii\web\Request
validateCsrfToken() Performs the CSRF validation. yii\web\Request

受保护的方法

隐藏继承方法

方法描述定义在
createCsrfCookie() Creates a cookie with a randomly generated CSRF token. yii\web\Request
generateCsrfToken() Generates an unmasked random token used to perform CSRF validation. yii\web\Request
loadCookies() Converts $_COOKIE into an array of yii\web\Cookie. yii\web\Request
loadCsrfToken() Loads the CSRF token from cookie or session. yii\web\Request
resolvePathInfo() Resolves the path info part of the currently requested URL. yii\web\Request
resolveRequestUri() Resolves the request URI portion for the currently requested URL. yii\web\Request

常量

隐藏继承常量

常量描述定义在
CSRF_HEADER 'X-CSRF-Token' The name of the HTTP header for sending CSRF token. yii\web\Request
CSRF_MASK_LENGTH 8 The length of the CSRF token mask. yii\web\Request

属性详情

$cookieValidationKey public property

A secret key used for cookie validation. This property must be set if $enableCookieValidation is true.

$csrfCookie public property

The configuration for creating the CSRF cookie. This property is used only when both $enableCsrfValidation and $enableCsrfCookie are true.

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

The name of the token used to prevent CSRF. Defaults to '_csrf'. This property is used only when $enableCsrfValidation is true.

public string $csrfParam '_csrf'
$enableCookieValidation public property

Whether cookies should be validated to ensure they are not tampered. Defaults to true.

$enableCsrfCookie public property

Whether to use cookie to persist CSRF token. If false, CSRF token will be stored in session under the name of $csrfParam. Note that while storing CSRF tokens in session increases security, it requires starting a session for every page, which will degrade your site performance.

public boolean $enableCsrfCookie true
$enableCsrfValidation public property

Whether to enable CSRF (Cross-Site Request Forgery) validation. Defaults to true. When CSRF validation is enabled, forms submitted to an Yii Web application must be originated from the same application. If not, a 400 HTTP exception will be raised.

Note, this feature requires that the user client accepts cookie. Also, to use this feature, forms submitted via POST method must contain a hidden input whose name is specified by $csrfParam. You may use yii\helpers\Html::beginForm() to generate his hidden input.

In JavaScript, you may get the values of $csrfParam and \yii\web\csrfToken via yii.getCsrfParam() and yii.getCsrfToken(), respectively. The yii\web\YiiAsset asset must be registered. You also need to include CSRF meta tags in your pages by using yii\helpers\Html::csrfMetaTags().

参见:

$methodParam public property

The name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE request tunneled through POST. Defaults to '_method'.

参见:

public string $methodParam '_method'
$parsers public property

The parsers for converting the raw HTTP request body into \yii\web\bodyParams. The array keys are the request Content-Types, and the array values are the corresponding configurations for Yii::createObject. A parser must implement the yii\web\RequestParserInterface.

To enable parsing for JSON requests you can use the yii\web\JsonParser class like in the following example:

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

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.

参见 getBodyParams().

public array $parsers = []

方法详情

createCsrfCookie() protected 方法

Creates a cookie with a randomly generated CSRF token.

Initial values specified in $csrfCookie will be applied to the generated cookie.

参见 $enableCsrfValidation.

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

The CSRF token

return yii\web\Cookie

The generated cookie

generateCsrfToken() protected 方法

Generates an unmasked random token used to perform CSRF validation.

protected string generateCsrfToken ( )
return string

The random token for CSRF validation.

get() public 方法

Returns GET parameter with a given name. If name isn't specified, returns an array of all GET parameters.

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

The parameter name

$defaultValue mixed

The default parameter value if the parameter does not exist.

getAbsoluteUrl() public 方法

Returns the currently requested absolute URL.

This is a shortcut to the concatenation of \yii\web\hostInfo and \yii\web\url.

public string getAbsoluteUrl ( )
return string

The currently requested absolute URL.

getAcceptableContentTypes() public 方法

Returns the content types acceptable by the end user.

This is determined by the Accept HTTP header. For example,

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

The content types ordered by the quality score. Types with the highest scores will be returned first. The array keys are the content types, while the array values are the corresponding quality score and other parameters as given in the header.

getAcceptableLanguages() public 方法

Returns the languages acceptable by the end user.

This is determined by the Accept-Language HTTP header.

public array getAcceptableLanguages ( )
return array

The languages ordered by the preference level. The first element represents the most preferred language.

getAuthPassword() public 方法

public string|null getAuthPassword ( )
return string|null

The password sent via HTTP authentication, null if the password is not given

getAuthUser() public 方法

public string|null getAuthUser ( )
return string|null

The username sent via HTTP authentication, null if the username is not given

getBaseUrl() public 方法

Returns the relative URL for the application.

This is similar to \yii\web\scriptUrl except that it does not include the script file name, and the ending slashes are removed.

参见 setScriptUrl().

public string getBaseUrl ( )
return string

The relative URL for the application

getBodyParam() public 方法

Returns the named request body parameter value.

If the parameter does not exist, the second parameter passed to this method will be returned.

参见:

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

The parameter name

$defaultValue mixed

The default parameter value if the parameter does not exist.

return mixed

The parameter value

getBodyParams() public 方法

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 \yii\web\contentType it uses the PHP function mb_parse_str() to parse the \yii\web\rawBody.

参见:

public array getBodyParams ( )
return array

The request parameters given in the request body.

throws yii\base\InvalidConfigException

if a registered parser does not implement the yii\web\RequestParserInterface.

getContentType() public 方法

Returns request content-type The Content-Type header field indicates the MIME type of the data contained in getRawBody() or, in the case of the HEAD method, the media type that would have been sent had the request been a GET.

For the MIME-types the user expects in response, see \yii\web\acceptableContentTypes.

public string getContentType ( )
return string

Request content-type. Null is returned if this information is not available.

getCookies() public 方法

Returns the cookie collection.

Through the returned cookie collection, you may access a cookie using the following syntax:

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

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

The cookie collection.

getCsrfToken() public 方法

Returns the token used to perform CSRF validation.

This token is generated in a way to prevent BREACH attacks. It may be passed along via a hidden field of an HTML form or an HTTP header value to support CSRF validation.

public string getCsrfToken ( $regenerate false )
$regenerate boolean

Whether to regenerate CSRF token. When this parameter is true, each time this method is called, a new CSRF token will be generated and persisted (in session or cookie).

return string

The token used to perform CSRF validation.

getCsrfTokenFromHeader() public 方法

public string getCsrfTokenFromHeader ( )
return string

The CSRF token sent via CSRF_HEADER by browser. Null is returned if no such header is sent.

getETags() public 方法

Gets the Etags.

public array getETags ( )
return array

The entity tags

getHeaders() public 方法

Returns the header collection.

The header collection contains incoming HTTP headers.

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

The header collection

getHostInfo() public 方法

Returns the schema and host part of the current request URL.

The returned URL does not have an ending slash.

By default this value is based on the user request information. This method will return the value of $_SERVER['HTTP_HOST'] if it is available or $_SERVER['SERVER_NAME'] if not. You may want to check out the PHP documentation for more information on these variables.

You may explicitly specify it by setting the hostInfo property.

Warning: Dependent on the server configuration this information may not be reliable and may be faked by the user sending the HTTP request. If the webserver is configured to serve the same site independent of the value of the Host header, this value is not reliable. In such situations you should either fix your webserver configuration or explicitly set the value by setting the hostInfo property. If you don't have access to the server configuration, you can setup yii\filters\HostControl filter at application level in order to protect against such kind of attack.

参见 setHostInfo().

public string|null getHostInfo ( )
return string|null

Schema and hostname part (with port number if needed) of the request URL (e.g. http://www.yiiframework.com), null if can't be obtained from $_SERVER and wasn't set.

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

Returns the host part of the current request URL.

Value is calculated from current hostInfo property.

Warning: The content of this value may not be reliable, dependent on the server configuration. Please refer to getHostInfo() for more information.

参见 getHostInfo().

public string|null getHostName ( )
return string|null

Hostname part of the request URL (e.g. www.yiiframework.com)

getIsAjax() public 方法

Returns whether this is an AJAX (XMLHttpRequest) request.

Note that jQuery doesn't set the header in case of cross domain requests: https://stackoverflow.com/questions/8163703/cross-domain-ajax-doesnt-send-x-requested-with-header

public boolean getIsAjax ( )
return boolean

Whether this is an AJAX (XMLHttpRequest) request.

getIsDelete() public 方法

Returns whether this is a DELETE request.

public boolean getIsDelete ( )
return boolean

Whether this is a DELETE request.

getIsFlash() public 方法

Returns whether this is an Adobe Flash or Flex request.

public boolean getIsFlash ( )
return boolean

Whether this is an Adobe Flash or Adobe Flex request.

getIsGet() public 方法

Returns whether this is a GET request.

public boolean getIsGet ( )
return boolean

Whether this is a GET request.

getIsHead() public 方法

Returns whether this is a HEAD request.

public boolean getIsHead ( )
return boolean

Whether this is a HEAD request.

getIsOptions() public 方法

Returns whether this is an OPTIONS request.

public boolean getIsOptions ( )
return boolean

Whether this is a OPTIONS request.

getIsPatch() public 方法

Returns whether this is a PATCH request.

public boolean getIsPatch ( )
return boolean

Whether this is a PATCH request.

getIsPjax() public 方法

Returns whether this is a PJAX request

public boolean getIsPjax ( )
return boolean

Whether this is a PJAX request

getIsPost() public 方法

Returns whether this is a POST request.

public boolean getIsPost ( )
return boolean

Whether this is a POST request.

getIsPut() public 方法

Returns whether this is a PUT request.

public boolean getIsPut ( )
return boolean

Whether this is a PUT request.

getIsSecureConnection() public 方法

Return if the request is sent via secure channel (https).

public boolean getIsSecureConnection ( )
return boolean

If the request is sent via secure channel (https)

getMethod() public 方法

Returns the method of the current request (e.g. GET, POST, HEAD, PUT, PATCH, DELETE).

public string getMethod ( )
return string

Request method, such as GET, POST, HEAD, PUT, PATCH, DELETE. The value returned is turned into upper case.

getPathInfo() public 方法

Returns the path info of the currently requested URL.

A path info refers to the part that is after the entry script and before the question mark (query string). The starting and ending slashes are both removed.

public string getPathInfo ( )
return string

Part of the request URL that is after the entry script and before the question mark. Note, the returned path info is already URL-decoded.

throws yii\base\InvalidConfigException

if the path info cannot be determined due to unexpected server configuration

getPort() public 方法

Returns the port to use for insecure requests.

Defaults to 80, or the port specified by the server if the current request is insecure.

参见 setPort().

public integer getPort ( )
return integer

Port number for insecure requests.

getPreferredLanguage() public 方法

Returns the user-preferred language that should be used by this application.

The language resolution is based on the user preferred languages and the languages supported by the application. The method will try to find the best match.

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

A list of the languages supported by the application. If this is empty, the current application language will be returned without further processing.

return string

The language that the application should use.

getQueryParam() public 方法

Returns the named GET parameter value.

If the GET parameter does not exist, the second parameter passed to this method will be returned.

参见 getBodyParam().

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

The GET parameter name.

$defaultValue mixed

The default parameter value if the GET parameter does not exist.

return mixed

The GET parameter value

getQueryParams() public 方法

Returns the request parameters given in the \yii\web\queryString.

This method will return the contents of $_GET if params where not explicitly set.

参见 setQueryParams().

public array getQueryParams ( )
return array

The request GET parameter values.

getQueryString() public 方法

Returns part of the request URL that is after the question mark.

public string getQueryString ( )
return string

Part of the request URL that is after the question mark

getRawBody() public 方法

Returns the raw HTTP request body.

public string getRawBody ( )
return string

The request body

getReferrer() public 方法

Returns the URL referrer.

public string|null getReferrer ( )
return string|null

URL referrer, null if not available

getScriptFile() public 方法

Returns the entry script file path.

The default implementation will simply return $_SERVER['SCRIPT_FILENAME'].

public string getScriptFile ( )
return string

The entry script file path

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

Returns the relative URL of the entry script.

The implementation of this method referenced Zend_Controller_Request_Http in Zend Framework.

public string getScriptUrl ( )
return string

The relative URL of the entry script.

throws yii\base\InvalidConfigException

if unable to determine the entry script URL

getSecurePort() public 方法

Returns the port to use for secure requests.

Defaults to 443, or the port specified by the server if the current request is secure.

参见 setSecurePort().

public integer getSecurePort ( )
return integer

Port number for secure requests.

getServerName() public 方法

Returns the server name.

public string getServerName ( )
return string

Server name, null if not available

getServerPort() public 方法

Returns the server port number.

public integer|null getServerPort ( )
return integer|null

Server port number, null if not available

getUrl() public 方法

Returns the currently requested relative URL.

This refers to the portion of the URL that is after the \yii\web\hostInfo part. It includes the \yii\web\queryString part if any.

public string getUrl ( )
return string

The currently requested relative URL. Note that the URI returned is URL-encoded.

throws yii\base\InvalidConfigException

if the URL cannot be determined due to unusual server configuration

getUserAgent() public 方法

Returns the user agent.

public string|null getUserAgent ( )
return string|null

User agent, null if not available

getUserHost() public 方法

Returns the user host name.

public string|null getUserHost ( )
return string|null

User host name, null if not available

getUserIP() public 方法

Returns the user IP address.

public string|null getUserIP ( )
return string|null

User IP address, null if not available

loadCookies() protected 方法

Converts $_COOKIE into an array of yii\web\Cookie.

protected array loadCookies ( )
return array

The cookies obtained from request

throws yii\base\InvalidConfigException

if $cookieValidationKey is not set when $enableCookieValidation is true

loadCsrfToken() protected 方法

Loads the CSRF token from cookie or session.

protected string loadCsrfToken ( )
return string

The CSRF token loaded from cookie or session. Null is returned if the cookie or session does not have CSRF token.

parseAcceptHeader() public 方法

Parses the given Accept (or Accept-Language) header.

This method will return the acceptable values with their quality scores and the corresponding parameters as specified in the given Accept header. The array keys of the return value are the acceptable values, while the array values consisting of the corresponding quality scores and parameters. The acceptable values with the highest quality scores will be returned first. For example,

$header = 'text/plain; q=0.5, application/json; version=1.0, application/xml; version=2.0;';
$accepts = $request->parseAcceptHeader($header);
print_r($accepts);
// displays:
// [
//     '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

The header to be parsed

return array

The acceptable values ordered by their quality score. The values with the highest scores will be returned first.

post() public 方法

Returns POST parameter with a given name. If name isn't specified, returns an array of all POST parameters.

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

The parameter name

$defaultValue mixed

The default parameter value if the parameter does not exist.

resolve() public 方法

Resolves the current request into a route and the associated parameters.

public array resolve ( )
return array

The first element is the route, and the second is the associated parameters.

throws yii\web\NotFoundHttpException

if the request cannot be resolved.

resolvePathInfo() protected 方法

Resolves the path info part of the currently requested URL.

A path info refers to the part that is after the entry script and before the question mark (query string). The starting slashes are both removed (ending slashes will be kept).

protected string resolvePathInfo ( )
return string

Part of the request URL that is after the entry script and before the question mark. Note, the returned path info is decoded.

throws yii\base\InvalidConfigException

if the path info cannot be determined due to unexpected server configuration

resolveRequestUri() protected 方法

Resolves the request URI portion for the currently requested URL.

This refers to the portion that is after the \yii\web\hostInfo part. It includes the \yii\web\queryString part if any. The implementation of this method referenced Zend_Controller_Request_Http in Zend Framework.

protected string|boolean resolveRequestUri ( )
return string|boolean

The request URI portion for the currently requested URL. Note that the URI returned is URL-encoded.

throws yii\base\InvalidConfigException

if the request URI cannot be determined due to unusual server configuration

setAcceptableContentTypes() public 方法

Sets the acceptable content types.

Please refer to getAcceptableContentTypes() on the format of the parameter.

参见:

public void setAcceptableContentTypes ( $value )
$value array

The content types that are acceptable by the end user. They should be ordered by the preference level.

setAcceptableLanguages() public 方法

public void setAcceptableLanguages ( $value )
$value array

The languages that are acceptable by the end user. They should be ordered by the preference level.

setBaseUrl() public 方法

Sets the relative URL for the application.

By default the URL is determined based on the entry script URL. This setter is provided in case you want to change this behavior.

public void setBaseUrl ( $value )
$value string

The relative URL for the application

setBodyParams() public 方法

Sets the request body parameters.

参见:

public void setBodyParams ( $values )
$values array

The request body parameters (name-value pairs)

setHostInfo() public 方法

Sets the schema and host part of the application URL.

This setter is provided in case the schema and hostname cannot be determined on certain Web servers.

参见 getHostInfo() for security related notes on this property.

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

The schema and host part of the application URL. The trailing slashes will be removed.

setPathInfo() public 方法

Sets the path info of the current request.

This method is mainly provided for testing purpose.

public void setPathInfo ( $value )
$value string

The path info of the current request

setPort() public 方法

Sets the port to use for insecure requests.

This setter is provided in case a custom port is necessary for certain server configurations.

public void setPort ( $value )
$value integer

Port number.

setQueryParams() public 方法

Sets the request \yii\web\queryString parameters.

参见:

public void setQueryParams ( $values )
$values array

The request query parameters (name-value pairs)

setRawBody() public 方法

Sets the raw HTTP request body, this method is mainly used by test scripts to simulate raw HTTP requests.

public void setRawBody ( $rawBody )
$rawBody string

The request body

setScriptFile() public 方法

Sets the entry script file path.

The entry script file path normally can be obtained from $_SERVER['SCRIPT_FILENAME']. If your server configuration does not return the correct value, you may configure this property to make it right.

public void setScriptFile ( $value )
$value string

The entry script file path.

setScriptUrl() public 方法

Sets the relative URL for the application entry script.

This setter is provided in case the entry script URL cannot be determined on certain Web servers.

public void setScriptUrl ( $value )
$value string

The relative URL for the application entry script.

setSecurePort() public 方法

Sets the port to use for secure requests.

This setter is provided in case a custom port is necessary for certain server configurations.

public void setSecurePort ( $value )
$value integer

Port number.

setUrl() public 方法

Sets the currently requested relative URL.

The URI must refer to the portion that is after \yii\web\hostInfo. Note that the URI should be URL-encoded.

public void setUrl ( $value )
$value string

The request URI to be set

validateCsrfToken() public 方法

Performs the CSRF validation.

This method will validate the user-provided CSRF token by comparing it with the one stored in cookie or session. This method is mainly called in yii\web\Controller::beforeAction().

Note that the method will NOT perform CSRF validation if $enableCsrfValidation is false or the HTTP method is among GET, HEAD or OPTIONS.

public boolean validateCsrfToken ( $token null )
$token string

The user-provided CSRF token to be validated. If null, the token will be retrieved from the $csrfParam POST field or HTTP header. This parameter is available since version 2.0.4.

return boolean

Whether CSRF token is valid. If $enableCsrfValidation is false, this method will return true.