## Class THttpRequest

Description

Implements interfaces:

- IModule

THttpRequest class

THttpRequest provides storage and access scheme for user request sent via HTTP. It also encapsulates a uniform way to parse and construct URLs.

User post data can be retrieved from THttpRequest by using it like an associative array. For example, to test if a user supplies a variable named 'param1', you can use,

       if(isset($request['param1'])) ...
       // equivalent to:
       // if($request->contains('param1')) ...

To get the value of 'param1', use,

       $value=$request['param1'];
       // equivalent to:
       //   $value=$request->itemAt('param1');

To traverse the user post data, use

       foreach($request as $name=>$value) ...

Note, POST and GET variables are merged together in THttpRequest. If a variable name appears in both POST and GET data, then POST data takes precedence.

To construct a URL that can be recognized by Prado, use constructUrl(). The format of the recognizable URLs is determined according to UrlManager. By default, the following two formats are recognized:

     /index.php?ServiceID=ServiceParameter&Name1=Value1&Name2=Value2
     /index.php/ServiceID,ServiceParameter/Name1,Value1/Name2,Value2

The first format is called 'Get' while the second 'Path', which is specified via UrlFormat. For advanced users who want to use their own URL formats, they can write customized URL management modules and install the managers as application modules and set UrlManager.

The ServiceID in the above URLs is as defined in the application configuration (e.g. the default page service's service ID is 'page'). As a consequence, your GET variable names should not conflict with the service IDs that your application supports.

THttpRequest also provides the cookies sent by the user, user information such as his browser capabilities, accepted languages, etc.

By default, THttpRequest is registered with TApplication as the request module. It can be accessed via TApplication::getRequest().

- since: 3.0
- version: $Id: THttpRequest.php 2541 2008-10-21 15:05:13Z qiang.xue $
- author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/THttpRequest.php (line 71)

    TComponent
       |
       --TApplicationComponent
          |
          --THttpRequest

Method Summary
void add (mixed $key, mixed $value)
void clear ()
string constructUrl (string $serviceID, string $serviceParam, [array $getItems = null], [boolean $encodeAmpersand = true], [boolean $encodeGetItems = true])
boolean contains (mixed $key)
integer count ()
string getAbsoluteApplicationUrl ([boolean $forceSecureConnection = false])
string getAcceptTypes ()
string getApplicationFilePath ()
string getApplicationUrl ()
string getBaseUrl ([boolean $forceSecureConnection = false])
array getBrowser ()
THttpCookieCollection getCookies ()
integer getCount ()
boolean getEnableCookieValidation ()
array getEnvironmentVariables ()
string getHttpProtocolVersion ()
string getID ()
boolean getIsSecureConnection ()
Iterator getIterator ()
array getKeys ()
string getPathInfo ()
string getQueryString ()
boolean getRequestResolved ()
string getRequestType ()
string getRequestUri ()
string getServerName ()
integer getServerPort ()
array getServerVariables ()
string getServiceID ()
string getServiceParameter ()
array getUploadedFiles ()
TUri getUrl ()
THttpRequestUrlFormat getUrlFormat ()
string getUrlManager ()
TUrlManager getUrlManagerModule ()
string getUrlParamSeparator ()
string getUrlReferrer ()
string getUserAgent ()
string getUserHost ()
string getUserHostAddress ()
array getUserLanguages ()
void init (TXmlElement $config)
mixed itemAt (mixed $key)
boolean offsetExists (mixed $offset)
mixed offsetGet (integer $offset)
void offsetSet (integer $offset, mixed $item)
void offsetUnset (mixed $offset)
array parseUrl ()
mixed remove (mixed $key)
string resolveRequest (array $serviceIDs)
void setEnableCookieValidation (boolean $value)
void setID (string $value)
void setServiceID (string $value)
void setServiceParameter (string $value)
void setUrlFormat (THttpRequestUrlFormat $value)
void setUrlManager (string $value)
void setUrlParamSeparator (string $value)
mixed stripSlashes (mixed &$data)
array toArray ()
Methods
add (line 716)

Adds an item into the request.

Note, if the specified key already exists, the old value will be overwritten.

- access: public

void add (mixed $key, mixed $value)

- mixed $key: key
- mixed $value: value

clear (line 742)

Removes all items in the request.

- access: public

void clear ()
constructUrl (line 569)

Constructs a URL that can be recognized by PRADO.

The actual construction work is done by the URL manager module. This method may append session information to the generated URL if needed. You may provide your own URL manager module by setting UrlManager to provide your own URL scheme.

Note, the constructed URL does not contain the protocol and hostname part. You may obtain an absolute URL by prepending the constructed URL with BaseUrl.

- return: URL
- access: public
- see: TUrlManager::constructUrl

string constructUrl (string $serviceID, string $serviceParam, [array $getItems = null], [boolean $encodeAmpersand = true], [boolean $encodeGetItems = true])

- string $serviceID: service ID
- string $serviceParam: service parameter
- array $getItems: GET parameters, null if not needed
- boolean $encodeAmpersand: whether to encode the ampersand in URL, defaults to true.
- boolean $encodeGetItems: whether to encode the GET parameters (their names and values), defaults to false.

contains (line 752)

- return: whether the request contains an item with the specified key
- access: public

boolean contains (mixed $key)

- mixed $key: the key

count (line 686)

Returns the number of items in the request.

This method is required by Countable interface.

- return: number of items in the request.
- access: public

integer count ()
getAbsoluteApplicationUrl (line 388)

- return: entry script URL (w/ host part)
- access: public

string getAbsoluteApplicationUrl ([boolean $forceSecureConnection = false])

- boolean $forceSecureConnection: whether to use HTTPS instead of HTTP even if the current request is sent via HTTP

getAcceptTypes (line 468)

- return: user browser accept types
- access: public

string getAcceptTypes ()
getApplicationFilePath (line 396)

- return: application entry script file path (processed w/ realpath())
- access: public

string getApplicationFilePath ()
getApplicationUrl (line 379)

- return: entry script URL (w/o host part)
- access: public

string getApplicationUrl ()
getBaseUrl (line 367)

- return: schema and hostname of the requested URL
- access: public

string getBaseUrl ([boolean $forceSecureConnection = false])

- boolean $forceSecureConnection: whether to use HTTPS instead of HTTP even if the current request is sent via HTTP

getBrowser (line 429)

- return: user browser capabilities
- access: public
- see: get_browser

array getBrowser ()
getCookies (line 505)

- return: list of cookies to be sent
- access: public

THttpCookieCollection getCookies ()
getCount (line 676)

- return: the number of items in the request
- access: public

integer getCount ()
getEnableCookieValidation (line 489)

- return: whether cookies should be validated. Defaults to false.
- access: public

boolean getEnableCookieValidation ()
getEnvironmentVariables (line 547)

- return: list of environment variables.
- access: public

array getEnvironmentVariables ()
getHttpProtocolVersion (line 350)

- return: the requested http procolol. Blank string if not defined.
- access: public

string getHttpProtocolVersion ()
getID (line 131)

- return: id of this module
- access: public

string getID ()
getIsSecureConnection (line 326)

- return: if the request is sent via secure channel (https)
- access: public

boolean getIsSecureConnection ()
getIterator (line 668)

Returns an iterator for traversing the items in the list.

This method is required by the interface IteratorAggregate.

- return: an iterator for traversing the items in the list.
- access: public

Iterator getIterator ()
getKeys (line 694)

- return: the key list
- access: public

array getKeys ()
getPathInfo (line 334)

- return: part of the request URL after script name and before question mark.
- access: public

string getPathInfo ()
getQueryString (line 342)

- return: part of that request URL after the question mark
- access: public

string getQueryString ()
getRequestResolved (line 622)

- return: true if request is already resolved, false otherwise.
- access: public

boolean getRequestResolved ()
getRequestType (line 318)

- return: request type, can be GET, POST, HEAD, or PUT
- access: public

string getRequestType ()
getRequestUri (line 358)

- return: part of that request URL after the host info (including pathinfo and query string)
- access: public

string getRequestUri ()
getServerName (line 404)

- return: server name
- access: public

string getServerName ()
getServerPort (line 412)

- return: server port number
- access: public

integer getServerPort ()
getServerVariables (line 539)

- return: list of server variables.
- access: public

array getServerVariables ()
getServiceID (line 630)

- return: requested service ID
- access: public

string getServiceID ()
getServiceParameter (line 647)

- return: requested service parameter
- access: public

string getServiceParameter ()
getUploadedFiles (line 531)

- return: list of uploaded files.
- access: public

array getUploadedFiles ()
getUrl (line 224)

- return: the request URL
- access: public

TUri getUrl ()
getUrlFormat (line 277)

- return: the format of URLs. Defaults to THttpRequestUrlFormat::Get.
- access: public

THttpRequestUrlFormat getUrlFormat ()
getUrlManager (line 248)

- return: the ID of the URL manager module
- access: public

string getUrlManager ()
getUrlManagerModule (line 269)

- return: the URL manager module
- access: public

TUrlManager getUrlManagerModule ()
getUrlParamSeparator (line 298)

- return: separator used to separate GET variable name and value when URL format is Path. Defaults to comma ','.
- access: public

string getUrlParamSeparator ()
getUrlReferrer (line 420)

- return: URL referrer, null if not present
- access: public

string getUrlReferrer ()
getUserAgent (line 444)

- return: user agent
- access: public

string getUserAgent ()
getUserHost (line 460)

- return: user host name, null if cannot be determined
- access: public

string getUserHost ()
getUserHostAddress (line 452)

- return: user IP address
- access: public

string getUserHostAddress ()
getUserLanguages (line 481)

Returns a list of user preferred languages.

The languages are returned as an array. Each array element represents a single language preference. The languages are ordered according to user preferences. The first language is the most preferred.

- return: list of user preferred languages.
- access: public

array getUserLanguages ()
init (line 149)

Initializes the module.

This method is required by IModule and is invoked by application.

- access: public

void init (TXmlElement $config)

- TXmlElement $config: module configuration

itemAt (line 705)

Returns the item with the specified key.

This method is exactly the same as offsetGet.

- return: the element at the offset, null if no element is found at the offset
- access: public

mixed itemAt (mixed $key)

- mixed $key: the key

offsetExists (line 771)

Returns whether there is an element at the specified offset.

This method is required by the interface ArrayAccess.

- access: public

boolean offsetExists (mixed $offset)

- mixed $offset: the offset to check on

offsetGet (line 782)

Returns the element at the specified offset.

This method is required by the interface ArrayAccess.

- return: the element at the offset, null if no element is found at the offset
- access: public

mixed offsetGet (integer $offset)

- integer $offset: the offset to retrieve element.

offsetSet (line 793)

Sets the element at the specified offset.

This method is required by the interface ArrayAccess.

- access: public

void offsetSet (integer $offset, mixed $item)

- integer $offset: the offset to set element
- mixed $item: the element value

offsetUnset (line 803)

Unsets the element at the specified offset.

This method is required by the interface ArrayAccess.

- access: public

void offsetUnset (mixed $offset)

- mixed $offset: the offset to unset element

parseUrl (line 584)

Parses the request URL and returns an array of input parameters (excluding GET variables).

You may override this method to support customized URL format.

- return: list of input parameters, indexed by parameter names
- access: protected
- see: TUrlManager::parseUrl

array parseUrl ()
remove (line 727)

Removes an item from the request by its key.

- return: the removed value, null if no such key exists.
- access: public
- throws: TInvalidOperationException if the item cannot be removed

mixed remove (mixed $key)

- mixed $key: the key of the item to be removed

resolveRequest (line 599)

Resolves the requested service.

This method implements a URL-based service resolution. A URL in the format of /index.php?sp=serviceID.serviceParameter will be resolved with the serviceID and the serviceParameter. You may override this method to provide your own way of service resolution.

- return: the currently requested service ID, null if no service ID is found
- access: public
- see: THttpRequest::constructUrl()

string resolveRequest (array $serviceIDs)

- array $serviceIDs: list of valid service IDs

setEnableCookieValidation (line 497)

- access: public

void setEnableCookieValidation (boolean $value)

- boolean $value: whether cookies should be validated.

setID (line 139)

- access: public

void setID (string $value)

- string $value: id of this module

setServiceID (line 639)

Sets the requested service ID.

- access: public

void setServiceID (string $value)

- string $value: requested service ID

setServiceParameter (line 656)

Sets the requested service parameter.

- access: public

void setServiceParameter (string $value)

- string $value: requested service parameter

setUrlFormat (line 290)

Sets the format of URLs constructed and interpretted by the request module.

A Get URL format is like index.php?name1=value1&name2=value2 while a Path URL format is like index.php/name1,value1/name2,value. Changing the UrlFormat will affect constructUrl and how GET variables are parsed.

- access: public

void setUrlFormat (THttpRequestUrlFormat $value)

- THttpRequestUrlFormat $value: the format of URLs.

setUrlManager (line 261)

Sets the URL manager module.

By default, TUrlManager is used for managing URLs. You may specify a different module for URL managing tasks by loading it as an application module and setting this property with the module ID.

- access: public

void setUrlManager (string $value)

- string $value: the ID of the URL manager module

setUrlParamSeparator (line 307)

- access: public
- throws: TInvalidDataValueException if the separator is not a single character

void setUrlParamSeparator (string $value)

- string $value: separator used to separate GET variable name and value when URL format is Path.

stripSlashes (line 216)

Strips slashes from input data.

This method is applied when magic quotes is enabled.

- return: processed data
- access: public

mixed stripSlashes (mixed &$data)

- mixed &$data: input data to be processed

toArray (line 760)

- return: the list of items in array
- access: public

array toArray ()

#### Inherited Methods

Inherited From TApplicationComponent

> TApplicationComponent::getApplication()
> TApplicationComponent::getRequest()
> TApplicationComponent::getResponse()
> TApplicationComponent::getService()
> TApplicationComponent::getSession()
> TApplicationComponent::getUser()
> TApplicationComponent::publishAsset()
> TApplicationComponent::publishFilePath()

Inherited From TComponent

> TComponent::addParsedObject()
> TComponent::attachEventHandler()
> TComponent::canGetProperty()
> TComponent::canSetProperty()
> TComponent::createdOnTemplate()
> TComponent::detachEventHandler()
> TComponent::evaluateExpression()
> TComponent::evaluateStatements()
> TComponent::getEventHandlers()
> TComponent::getSubProperty()
> TComponent::hasEvent()
> TComponent::hasEventHandler()
> TComponent::hasProperty()
> TComponent::raiseEvent()
> TComponent::setSubProperty()
> TComponent::__get()
> TComponent::__set()

Documentation generated on Sun, 11 Jan 2009 20:22:39 -0500 by phpDocumentor 1.3.0RC4