CHttpRequest

Package	system.web
Inheritance	class CHttpRequest » CApplicationComponent » CComponent
Implements	IApplicationComponent
Since	1.0
Version	$Id$
Source Code	framework/web/CHttpRequest.php

Property Details

user browser accept types

Returns the relative URL for the application. This is similar to scriptUrl except that it does not have the script file name, and the ending slashes are stripped off.

Returns information about the capabilities of user browser.

Returns the cookie collection. The result can be used like an associative array. Adding CHttpCookie objects to the collection will send the cookies to the client; and removing the objects from the collection will delete those cookies on the client.

the property values (in name-value pairs) used to initialize the CSRF cookie. Any property of CHttpCookie may be initialized. This property is effective only when enableCsrfValidation is true.

Returns the random token used to perform CSRF validation. The token will be read from cookie first. If not found, a new token will be generated.

the name of the token used to prevent CSRF. Defaults to 'YII_CSRF_TOKEN'. This property is effectively only when enableCsrfValidation is true.

whether cookies should be validated to ensure they are not tampered. Defaults to false.

whether to enable CSRF (Cross-Site Request Forgery) validation. Defaults to false. By setting this property to true, 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. You also need to use CHtml::form or CHtml::statefulForm to generate the needed HTML forms in your pages.

Returns the schema and host part of the application URL. The returned URL does not have an ending slash. By default this is determined based on the user request information. You may explicitly specify it by setting the hostInfo property.

whether this is an AJAX (XMLHttpRequest) request.

whether this is POST request.

if the request is sent via secure channel (https)

Returns the path info of the currently requested URL. This refers to the part that is after the entry script and before the question mark. The starting and ending slashes are stripped off.

the user preferred language. The returned language ID will be canonicalized using CLocale::getCanonicalID. This method returns false if the user does not have language preference.

part of the request URL that is after the question mark

request type, such as GET, POST, HEAD, PUT, DELETE.

Returns the request URI portion for the currently requested URL. This refers to the portion that is after the host info part. It includes the query string part if any. The implementation of this method referenced Zend_Controller_Request_Http in Zend Framework.

entry script file path (processed w/ realpath())

Returns the relative URL of the entry script. The implementation of this method referenced Zend_Controller_Request_Http in Zend Framework.

server name

server port number

part of the request URL after the host info. It consists of the following parts:

• scriptUrl
• pathInfo
• queryString

URL referrer, null if not present

user agent

user host name, null if cannot be determined

user IP address

Method Details

protected CHttpCookie createCsrfCookie()
{return}	CHttpCookie	the generated cookie

Creates a cookie with a randomly generated CSRF token. Initial values specified in csrfCookie will be applied to the generated cookie.

public string getAcceptTypes()
{return}	string	user browser accept types

public string getBaseUrl(boolean $absolute=false)
$absolute	boolean	whether to return an absolute URL. Defaults to false, meaning returning a relative one. This parameter has been available since 1.0.2.
{return}	string	the relative URL for the application

Returns the relative URL for the application. This is similar to scriptUrl except that it does not have the script file name, and the ending slashes are stripped off.

public array getBrowser(string $userAgent=NULL)
$userAgent	string	the user agent to be analyzed. Defaults to null, meaning using the current User-Agent HTTP header information.
{return}	array	user browser capabilities.

Returns information about the capabilities of user browser.

public CCookieCollection getCookies()
{return}	CCookieCollection	the cookie collection.

Returns the cookie collection. The result can be used like an associative array. Adding CHttpCookie objects to the collection will send the cookies to the client; and removing the objects from the collection will delete those cookies on the client.

public string getCsrfToken()
{return}	string	the random token for CSRF validation.

Returns the random token used to perform CSRF validation. The token will be read from cookie first. If not found, a new token will be generated.

public string getHostInfo(string $schema='')
$schema	string	schema to use (e.g. http, https). If empty, the schema used for the current request will be used.
{return}	string	schema and hostname part (with port number if needed) of the request URL (e.g. https://www.yiiframework.com)

Returns the schema and host part of the application URL. The returned URL does not have an ending slash. By default this is determined based on the user request information. You may explicitly specify it by setting the hostInfo property.

public boolean getIsAjaxRequest()
{return}	boolean	whether this is an AJAX (XMLHttpRequest) request.

public boolean getIsPostRequest()
{return}	boolean	whether this is POST request.

public boolean getIsSecureConnection()
{return}	boolean	if the request is sent via secure channel (https)

public mixed getParam(string $name, mixed $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

Returns the named GET or POST parameter value. If the GET or POST parameter does not exist, the second parameter to this method will be returned. If both GET and POST contains such a named parameter, the GET parameter takes precedence.

public string getPathInfo()
{return}	string	part of the request URL that is after the entry script and before the question mark.

Returns the path info of the currently requested URL. This refers to the part that is after the entry script and before the question mark. The starting and ending slashes are stripped off.

public mixed getPost(string $name, mixed $defaultValue=NULL)
$name	string	the POST parameter name
$defaultValue	mixed	the default parameter value if the POST parameter does not exist.
{return}	mixed	the POST parameter value

Returns the named POST parameter value. If the POST parameter does not exist, the second parameter to this method will be returned.

public string getPreferredLanguage()
{return}	string	the user preferred language. The returned language ID will be canonicalized using CLocale::getCanonicalID. This method returns false if the user does not have language preference.

public mixed getQuery(string $name, mixed $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

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

public string getQueryString()
{return}	string	part of the request URL that is after the question mark

public string getRequestType()
{return}	string	request type, such as GET, POST, HEAD, PUT, DELETE.

public string getRequestUri()
{return}	string	the request URI portion for the currently requested URL.

Returns the request URI portion for the currently requested URL. This refers to the portion that is after the host info part. It includes the query string part if any. The implementation of this method referenced Zend_Controller_Request_Http in Zend Framework.

public string getScriptFile()
{return}	string	entry script file path (processed w/ realpath())

public string getScriptUrl()
{return}	string	the relative URL of the entry script.

Returns the relative URL of the entry script. The implementation of this method referenced Zend_Controller_Request_Http in Zend Framework.

public string getServerName()
{return}	string	server name

public integer getServerPort()
{return}	integer	server port number

public string getUrl()
{return}	string	part of the request URL after the host info. It consists of the following parts: scriptUrl pathInfo queryString

public string getUrlReferrer()
{return}	string	URL referrer, null if not present

public string getUserAgent()
{return}	string	user agent

public string getUserHost()
{return}	string	user host name, null if cannot be determined

public string getUserHostAddress()
{return}	string	user IP address

public void init()

Initializes the application component. This method overrides the parent implementation by preprocessing the user request data.

protected void normalizeRequest()

Normalizes the request data. This method strips off slashes in request data if get_magic_quotes_gpc() returns true. It also performs CSRF validation if enableCsrfValidation is true.

public void redirect(string $url, boolean $terminate=true, integer $statusCode=302)
$url	string	URL to be redirected to. If the URL is a relative one, the base URL of the application will be inserted at the beginning.
$terminate	boolean	whether to terminate the current application
$statusCode	integer	the HTTP status code. Defaults to 302. See https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for details about HTTP status code. This parameter has been available since version 1.0.4.

Redirects the browser to the specified URL.

public void sendFile(string $fileName, string $content, string $mimeType=NULL, boolean $terminate=true)
$fileName	string	file name
$content	string	content to be set.
$mimeType	string	mime type of the content. If null, it will be guessed automatically based on the given file name.
$terminate	boolean	whether to terminate the current application after calling this method

Sends a file to user.

public void setBaseUrl(string $value)
$value	string	the relative URL for the application

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 setHostInfo(string $value)
$value	string	the schema and host part of the application URL.

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.

public void setScriptUrl(string $value)
$value	string	the relative URL for the application entry script.

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 mixed stripSlashes(mixed &$data)
$data	mixed	input data to be processed
{return}	mixed	processed data

Strips slashes from input data. This method is applied when magic quotes is enabled.

public void validateCsrfToken(CEvent $event)
$event	CEvent	event parameter

Performs the CSRF validation. This is the event handler responding to CApplication::onBeginRequest. The default implementation will compare the CSRF token obtained from a cookie and from a POST field. If they are different, a CSRF attack is detected.