public string getAbsoluteUrl ( )

public array getAcceptableContentTypes ( )
public void setAcceptableContentTypes ( $value )

public array getAcceptableLanguages ( )
public void setAcceptableLanguages ( $value )

public string|null getAuthPassword ( )

public string|null getAuthUser ( )

public string getBaseUrl ( )
public void setBaseUrl ( $value )

public array getBodyParams ( )
public void setBodyParams ( $values )

public string getContentType ( )

public string $cookieValidationKey = null

public yii\web\CookieCollection getCookies ( )

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

public string $csrfParam = '_csrf'

public string getCsrfToken ( $regenerate = false )

public string getCsrfTokenFromHeader ( )

public array getETags ( )

public boolean $enableCookieValidation = true

public boolean $enableCsrfCookie = true

public boolean $enableCsrfValidation = true

public yii\web\HeaderCollection getHeaders ( )

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

public string|null getHostName ( )

public boolean getIsAjax ( )

public boolean getIsDelete ( )

public boolean getIsFlash ( )

public boolean getIsGet ( )

public boolean getIsHead ( )

public boolean getIsOptions ( )

public boolean getIsPatch ( )

public boolean getIsPjax ( )

public boolean getIsPost ( )

public boolean getIsPut ( )

public boolean getIsSecureConnection ( )

public string getMethod ( )

public string $methodParam = '_method'

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

public array $parsers = []

public string getPathInfo ( )
public void setPathInfo ( $value )

public integer getPort ( )
public void setPort ( $value )

public string getPreferredLanguage ( array $languages = [] )

public array getQueryParams ( )
public void setQueryParams ( $values )

public string getQueryString ( )

public string getRawBody ( )
public void setRawBody ( $rawBody )

public string|null getReferrer ( )

public string getScriptFile ( )
public void setScriptFile ( $value )

public string getScriptUrl ( )
public void setScriptUrl ( $value )

public integer getSecurePort ( )
public void setSecurePort ( $value )

public string getServerName ( )

public integer|null getServerPort ( )

public string getUrl ( )
public void setUrl ( $value )

public string|null getUserAgent ( )

public string|null getUserHost ( )

public string|null getUserIP ( )

createCsrfCookie() protected method

Creates a cookie with a randomly generated CSRF token.

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

See also $enableCsrfValidation.

protected yii\web\Cookie createCsrfCookie ( $token )
$token	string	The CSRF token
return	yii\web\Cookie	The generated cookie

generateCsrfToken() protected method

Generates an unmasked random token used to perform CSRF validation.

protected string generateCsrfToken ( )
return	string	The random token for CSRF validation.

get() public method

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 method

Returns the currently requested absolute URL.

This is a shortcut to the concatenation of $hostInfo and $url.

public string getAbsoluteUrl ( )
return	string	The currently requested absolute URL.

getAcceptableContentTypes() public method

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 method

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 method

public string|null getAuthPassword ( )
return	string|null	The password sent via HTTP authentication, null if the password is not given

getAuthUser() public method

public string|null getAuthUser ( )
return	string|null	The username sent via HTTP authentication, null if the username is not given

getBaseUrl() public method

Returns the relative URL for the application.

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

See also setScriptUrl().

public string getBaseUrl ( )
return	string	The relative URL for the application

getBodyParam() public method

Returns the named request body parameter value.

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

See also:

• getBodyParams()
• setBodyParams()

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 method

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 request body.

See also:

• getMethod()
• getBodyParam()
• setBodyParams()

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 method

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 $acceptableContentTypes.

public string getContentType ( )
return	string	Request content-type. Null is returned if this information is not available.

getCookies() public method

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 method

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 method

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 method

Gets the Etags.

public array getETags ( )
return	array	The entity tags

getHeaders() public method

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 method

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.

See also 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 method (available since version 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.

See also getHostInfo().

public string|null getHostName ( )
return	string|null	Hostname part of the request URL (e.g. www.yiiframework.com)

getIsAjax() public method

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 method

Returns whether this is a DELETE request.

public boolean getIsDelete ( )
return	boolean	Whether this is a DELETE request.

getIsFlash() public method

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 method

Returns whether this is a GET request.

public boolean getIsGet ( )
return	boolean	Whether this is a GET request.

getIsHead() public method

Returns whether this is a HEAD request.

public boolean getIsHead ( )
return	boolean	Whether this is a HEAD request.

getIsOptions() public method

Returns whether this is an OPTIONS request.

public boolean getIsOptions ( )
return	boolean	Whether this is a OPTIONS request.

getIsPatch() public method

Returns whether this is a PATCH request.

public boolean getIsPatch ( )
return	boolean	Whether this is a PATCH request.

getIsPjax() public method

Returns whether this is a PJAX request

public boolean getIsPjax ( )
return	boolean	Whether this is a PJAX request

getIsPost() public method

Returns whether this is a POST request.

public boolean getIsPost ( )
return	boolean	Whether this is a POST request.

getIsPut() public method

Returns whether this is a PUT request.

public boolean getIsPut ( )
return	boolean	Whether this is a PUT request.

getIsSecureConnection() public method

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 method

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 method

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 method

Returns the port to use for insecure requests.

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

See also setPort().

public integer getPort ( )
return	integer	Port number for insecure requests.

getPreferredLanguage() public method

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 method

Returns the named GET parameter value.

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

See also 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 method

Returns the request parameters given in the $queryString.

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

See also setQueryParams().

public array getQueryParams ( )
return	array	The request GET parameter values.

getQueryString() public method

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 method

Returns the raw HTTP request body.

public string getRawBody ( )
return	string	The request body

getReferrer() public method

Returns the URL referrer.

public string|null getReferrer ( )
return	string|null	URL referrer, null if not available

getScriptFile() public method

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 method

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 method

Returns the port to use for secure requests.

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

See also setSecurePort().

public integer getSecurePort ( )
return	integer	Port number for secure requests.

getServerName() public method

Returns the server name.

public string getServerName ( )
return	string	Server name, null if not available

getServerPort() public method

Returns the server port number.

public integer|null getServerPort ( )
return	integer|null	Server port number, null if not available

getUrl() public method

Returns the currently requested relative URL.

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

public string getUrl ( )
return	string	The currently requested relative URL. Note that the URI returned may be URL-encoded depending on the client.
throws	yii\base\InvalidConfigException	if the URL cannot be determined due to unusual server configuration

getUserAgent() public method

Returns the user agent.

public string|null getUserAgent ( )
return	string|null	User agent, null if not available

getUserHost() public method

Returns the user host name.

public string|null getUserHost ( )
return	string|null	User host name, null if not available

getUserIP() public method

Returns the user IP address.

public string|null getUserIP ( )
return	string|null	User IP address, null if not available

loadCookies() protected method

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 method

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 method

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 method

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 method

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 method

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 method

Resolves the request URI portion for the currently requested URL.

This refers to the portion that is after the $hostInfo part. It includes the $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 may be URL-encoded depending on the client.
throws	yii\base\InvalidConfigException	if the request URI cannot be determined due to unusual server configuration

setAcceptableContentTypes() public method

Sets the acceptable content types.

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

See also:

• getAcceptableContentTypes()
• parseAcceptHeader()

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 method

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 method

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 method

Sets the request body parameters.

See also:

• getBodyParam()
• getBodyParams()

public void setBodyParams ( $values )
$values	array	The request body parameters (name-value pairs)

setHostInfo() public method

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.

See also 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 method

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 method

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 method

Sets the request $queryString parameters.

See also:

• getQueryParam()
• getQueryParams()

public void setQueryParams ( $values )
$values	array	The request query parameters (name-value pairs)

setRawBody() public method

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 method

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 method

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 method

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 method

Sets the currently requested relative URL.

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

public void setUrl ( $value )
$value	string	The request URI to be set

validateCsrfToken() public method

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 ( $clientSuppliedToken = null )
$clientSuppliedToken	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.