CHttpRequest

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

Property Details

Returns user browser accept types, null if not present.

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

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.

Returns the version of the HTTP protocol used by client.

Returns whether this is an AJAX (XMLHttpRequest) request.

Returns whether this is a DELETE request.

Returns whether this is a DELETE request which was tunneled through POST.

Returns whether this is an Adobe Flash or Adobe Flex request.

Returns whether this is a PATCH request.

Returns whether this is a PATCH request which was tunneled through POST.

Returns whether this is a POST request.

Returns whether this is a PUT request.

Returns whether this is a PUT request which was tunneled through POST.

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

whether the parsing of JSON REST requests should return associative arrays for object data.

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.

Returns the port to use for insecure requests. Defaults to 80, or the port specified by the server if the current request is insecure. You may explicitly specify it by setting the port property.

Returns the user preferred accept MIME type. The MIME type is returned as an array map (see parseAcceptHeader()).

Returns an array of user accepted MIME types in order of preference. Each array entry consists of a map with the type, subType, baseType and params, an array map of key-value parameters. See parseAcceptHeader() for a description of the array map.

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.

Returns an array of user accepted languages in order of preference. The returned language IDs will NOT be canonicalized using CLocale::getCanonicalID.

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

Returns the raw HTTP request body.

Returns the request type, such as GET, POST, HEAD, PUT, PATCH, DELETE. Request type can be manually set in POST requests with a parameter named _method. Useful for RESTful request from older browsers which do not support PUT, PATCH or DELETE natively (available since version 1.1.11).

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.

Returns request parameters. Typically PUT, PATCH or DELETE.

Returns entry script file path.

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

Returns the port to use for secure requests. Defaults to 443, or the port specified by the server if the current request is secure. You may explicitly specify it by setting the securePort property.

Returns the server name.

Returns the server port number.

Returns the currently requested URL. This is the same as getRequestUri.

Returns the URL referrer, null if not present

Returns the user agent, null if not present.

Returns the user host name, null if it cannot be determined.

Returns the user IP address.

Method Details

public static integer compareAcceptTypes(array $a, array $b)
$a	array	user accepted MIME type as an array map
$b	array	user accepted MIME type as an array map
{return}	integer	-1, 0 or 1 if $a has respectively greater preference, equal preference or less preference than $b (higher preference comes first).

Compare function for determining the preference of accepted MIME type array maps See parseAcceptHeader() for the format of $a and $b

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.

protected string decodePathInfo(string $pathInfo)
$pathInfo	string	encoded path info
{return}	string	decoded path info

Decodes the path info. This method is an improved variant of the native urldecode() function and used in getPathInfo() to decode the path part of the request URI. You may override this method to change the way the path info is being decoded.

public string getAcceptTypes()
{return}	string	user browser accept types, null if not present

Returns user browser accept types, null if not present.

public string getBaseUrl(boolean $absolute=false)
$absolute	boolean	whether to return an absolute URL. Defaults to false, meaning returning a relative one.
{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 string getContentType()
{return}	string	request content-type. Null is returned if this information is not available.

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.

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 mixed getDelete(string $name, mixed $defaultValue=NULL)
$name	string	the DELETE parameter name
$defaultValue	mixed	the default parameter value if the DELETE parameter does not exist.
{return}	mixed	the DELETE parameter value

Returns the named DELETE parameter value. If the DELETE parameter does not exist or if the current request is not a DELETE request, the second parameter to this method will be returned. If the DELETE request was tunneled through POST via _method parameter, the POST parameter will be returned instead (available since version 1.1.11).

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 string getHttpVersion()
{return}	string	the version of the HTTP protocol.

Returns the version of the HTTP protocol used by client.

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

Returns whether this is an AJAX (XMLHttpRequest) request.

public boolean getIsDeleteRequest()
{return}	boolean	whether this is a DELETE request.

Returns whether this is a DELETE request.

protected boolean getIsDeleteViaPostRequest()
{return}	boolean	whether this is a DELETE request tunneled through POST.

Returns whether this is a DELETE request which was tunneled through POST.

public boolean getIsFlashRequest()
{return}	boolean	whether this is an Adobe Flash or Adobe Flex request.

Returns whether this is an Adobe Flash or Adobe Flex request.

public boolean getIsPatchRequest()
{return}	boolean	whether this is a PATCH request.

Returns whether this is a PATCH request.

protected boolean getIsPatchViaPostRequest()
{return}	boolean	whether this is a PATCH request tunneled through POST.

Returns whether this is a PATCH request which was tunneled through POST.

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

Returns whether this is a POST request.

public boolean getIsPutRequest()
{return}	boolean	whether this is a PUT request.

Returns whether this is a PUT request.

protected boolean getIsPutViaPostRequest()
{return}	boolean	whether this is a PUT request tunneled through POST.

Returns whether this is a PUT request which was tunneled through POST.

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

Return 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 mixed getPatch(string $name, mixed $defaultValue=NULL)
$name	string	the PATCH parameter name
$defaultValue	mixed	the default parameter value if the PATCH parameter does not exist.
{return}	mixed	the PATCH parameter value

Returns the named PATCH parameter value. If the PATCH parameter does not exist or if the current request is not a PATCH request, the second parameter to this method will be returned. If the PATCH request was tunneled through POST via _method parameter, the POST parameter will be returned instead.

public string getPathInfo()
{return}	string	part of the request URL that is after the entry script and before the question mark. Note, the returned pathinfo is decoded starting from 1.1.4. Prior to 1.1.4, whether it is decoded or not depends on the server configuration (in most cases it is not decoded).

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 integer getPort()
{return}	integer	port number for insecure requests.

Returns the port to use for insecure requests. Defaults to 80, or the port specified by the server if the current request is insecure. You may explicitly specify it by setting the port property.

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 array getPreferredAcceptType()
{return}	array	the user preferred accept MIME type or false if the user does not have any.

Returns the user preferred accept MIME type. The MIME type is returned as an array map (see parseAcceptHeader()).

public array getPreferredAcceptTypes()
{return}	array	the user accepted MIME types, as array maps, in the order of preference.

Returns an array of user accepted MIME types in order of preference. Each array entry consists of a map with the type, subType, baseType and params, an array map of key-value parameters. See parseAcceptHeader() for a description of the array map.

public string getPreferredLanguage(array $languages=array ( ))
$languages	array	a list of the languages supported by the application. If empty, this method will return the first language returned by [[getPreferredLanguages()]].
{return}	string	the language that the application should use. false is returned if both [[getPreferredLanguages()]] and `$languages` are empty.

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 array getPreferredLanguages()
{return}	array	the user accepted languages in the order of preference. See https://tools.ietf.org/html/rfc2616#section-14.4

Returns an array of user accepted languages in order of preference. The returned language IDs will NOT be canonicalized using CLocale::getCanonicalID.

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

Returns the named PUT parameter value. If the PUT parameter does not exist or if the current request is not a PUT request, the second parameter to this method will be returned. If the PUT request was tunneled through POST via _method parameter, the POST parameter will be returned instead (available since version 1.1.11).

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

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

public string getRawBody()
{return}	string	the request body

Returns the raw HTTP request body.

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

Returns the request type, such as GET, POST, HEAD, PUT, PATCH, DELETE. Request type can be manually set in POST requests with a parameter named _method. Useful for RESTful request from older browsers which do not support PUT, PATCH or DELETE natively (available since version 1.1.11).

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 array getRestParams()
{return}	array	the request parameters

Returns request parameters. Typically PUT, PATCH or DELETE.

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

Returns entry script file path.

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 integer getSecurePort()
{return}	integer	port number for secure requests.

Returns the port to use for secure requests. Defaults to 443, or the port specified by the server if the current request is secure. You may explicitly specify it by setting the securePort property.

public string getServerName()
{return}	string	server name

Returns the server name.

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

Returns the server port number.

public string getUrl()
{return}	string	part of the request URL after the host info.

Returns the currently requested URL. This is the same as getRequestUri.

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

Returns the URL referrer, null if not present

public string getUserAgent()
{return}	string	user agent, null if not present

Returns the user agent, null if not present.

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

Returns the user host name, null if it cannot be determined.

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

Returns the 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 static array parseAcceptHeader(string $header)
$header	string	the accept header value to parse
{return}	array	the user accepted MIME types.

Parses an HTTP Accept header, returning an array map with all parts of each entry. Each array entry consists of a map with the type, subType, baseType and params, an array map of key-value parameters, obligatorily including a `q` value (i.e. preference ranking) as a double. For example, an Accept header value of 'application/xhtml+xml;q=0.9;level=1' would give an array entry of

array(
       'type' => 'application',
       'subType' => 'xhtml',
       'baseType' => 'xml',
       'params' => array(
           'q' => 0.9,
           'level' => '1',
       ),
)

Please note: To avoid great complexity, there are no steps taken to ensure that quoted strings are treated properly. If the header text includes quoted strings containing space or the , or ; characters then the results may not be correct!

See also https://tools.ietf.org/html/rfc2616#section-14.1 for details on Accept header.

public void redirect(string $url, boolean $terminate=true, integer $statusCode=302)
$url	string	URL to be redirected to. Note that when URL is not absolute (not starting with "/") it will be relative to current request URL.
$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.

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 setPort(integer $value)
$value	integer	port number.

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 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 void setSecurePort(integer $value)
$value	integer	port number.

Sets the port to use for secure requests. This setter is provided in case a custom port is necessary for certain server configurations.

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.

public void xSendFile(string $filePath, array $options=array ( ))
$filePath	string	file name with full path
$options	array	additional options: saveName: file name shown to the user, if not set real file name will be used mimeType: mime type of the file, if not set it will be guessed automatically based on the file name, if set to null no content-type header will be sent. xHeader: appropriate x-sendfile header, defaults to "X-Sendfile" terminate: whether to terminate the current application after calling this method, defaults to true forceDownload: specifies whether the file will be downloaded or shown inline, defaults to true. (Since version 1.1.9.) addHeaders: an array of additional http headers in header-value pairs (available since version 1.1.10)

Sends existing file to a browser as a download using x-sendfile.

X-Sendfile is a feature allowing a web application to redirect the request for a file to the webserver that in turn processes the request, this way eliminating the need to perform tasks like reading the file and sending it to the user. When dealing with a lot of files (or very big files) this can lead to a great increase in performance as the web application is allowed to terminate earlier while the webserver is handling the request.

The request is sent to the server through a special non-standard HTTP-header. When the web server encounters the presence of such header it will discard all output and send the file specified by that header using web server internals including all optimizations like caching-headers.

As this header directive is non-standard different directives exists for different web servers applications:

• Apache: X-Sendfile
• Lighttpd v1.4: X-LIGHTTPD-send-file
• Lighttpd v1.5: X-Sendfile
• Nginx: X-Accel-Redirect
• Cherokee: X-Sendfile and X-Accel-Redirect

So for this method to work the X-SENDFILE option/module should be enabled by the web server and a proper xHeader should be sent.

Note: This option allows to download files that are not under web folders, and even files that are otherwise protected (deny from all) like .htaccess

Side effects: If this option is disabled by the web server, when this method is called a download configuration dialog will open but the downloaded file will have 0 bytes.

Known issues: There is a Bug with Internet Explorer 6, 7 and 8 when X-SENDFILE is used over an SSL connection, it will show an error message like this: "Internet Explorer was not able to open this Internet site. The requested site is either unavailable or cannot be found.". You can work around this problem by removing the Pragma-header.

Example:

<?php
   Yii::app()->request->xSendFile('/home/user/Pictures/picture1.jpg',array(
       'saveName'=>'image1.jpg',
       'mimeType'=>'image/jpeg',
       'terminate'=>false,
   ));
?>