• Home
• Prado
• Web
• THttpRequest

PHP Class Prado\Web\THttpRequest

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 {@link constructUrl()}. The format of the recognizable URLs is determined according to {@link setUrlManager 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 {@link setUrlFormat 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 {@link setUrlManager 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 {@link TApplication} as the request module. It can be accessed via {@link TApplication::getRequest()}. Datei anzeigen Open project: pradosoft/prado Class Usage Examples

Public Methods

Method	Description
add ( $key, $value )	Adds an item into the request.
clear ( )	Removes all items in the request.
constructUrl ( $serviceID, $serviceParam, $getItems = null, $encodeAmpersand = true, $encodeGetItems = true ) : string	Constructs a URL that can be recognized by PRADO.
contains ( $key ) : boolean
count ( ) : integer	Returns the number of items in the request.
getAbsoluteApplicationUrl ( $forceSecureConnection = null ) : string
getAcceptTypes ( ) : string
getApplicationFilePath ( ) : string
getApplicationUrl ( ) : string
getBaseUrl ( $forceSecureConnection = null ) : string
getBrowser ( ) : array
getCgiFix ( ) : integer
getContentType ( boolean $mimetypeOnly = true ) : string
getCookies ( ) : THttpCookieCollection
getCount ( ) : integer
getEnableCache ( ) : boolean
getEnableCookieValidation ( ) : boolean
getEnvironmentVariables ( ) : array
getHeaders ( $case = null ) : array
getHttpProtocolVersion ( ) : string
getID ( ) : string
getIsSecureConnection ( ) : boolean
getIterator ( ) : Iterator	Returns an iterator for traversing the items in the list.
getKeys ( ) : array
getPathInfo ( ) : string
getQueryString ( ) : string
getRequestResolved ( ) : boolean
getRequestType ( ) : string
getRequestUri ( ) : string
getServerName ( ) : string
getServerPort ( ) : integer
getServerVariables ( ) : array
getServiceID ( ) : string
getServiceParameter ( ) : string
getUploadedFiles ( ) : array
getUrl ( ) : TUri
getUrlFormat ( ) : THttpRequestUrlFormat
getUrlManager ( ) : string
getUrlManagerModule ( ) : TUrlManager
getUrlParamSeparator ( ) : string
getUrlReferrer ( ) : string
getUserAgent ( ) : string
getUserHost ( ) : string
getUserHostAddress ( ) : string
getUserLanguages ( ) : array	Returns a list of user preferred languages.
init ( $config )	Initializes the module.
itemAt ( $key ) : mixed	Returns the item with the specified key.
offsetExists ( $offset ) : boolean	Returns whether there is an element at the specified offset.
offsetGet ( $offset ) : mixed	Returns the element at the specified offset.
offsetSet ( $offset, $item )	Sets the element at the specified offset.
offsetUnset ( $offset )	Unsets the element at the specified offset.
remove ( $key ) : mixed	Removes an item from the request by its key.
resolveRequest ( $serviceIDs ) : string	Resolves the requested service.
setCgiFix ( $value )	Enable this, if you're using PHP via CGI with php.ini setting "cgi.fix_pathinfo=1" and have trouble with friendly URL feature. Enable this only if you really know what you are doing!
setEnableCache ( $value )	Set true to cache the UrlManager instance. Consider to enable this cache when the application defines a lot of TUrlMappingPatterns
setEnableCookieValidation ( $value )
setID ( $value )
setServiceID ( $value )	Sets the requested service ID.
setServiceParameter ( $value )	Sets the requested service parameter.
setUrlFormat ( $value )	Sets the format of URLs constructed and interpretted by the request module.
setUrlManager ( $value )	Sets the URL manager module.
setUrlParamSeparator ( $value )
stripSlashes ( &$data ) : mixed	Strips slashes from input data.
toArray ( ) : array

Protected Methods

Method	Description
cacheUrlManager ( $manager ) : boolean	Saves the current UrlManager instance to cache.
getCacheKey ( )
loadCachedUrlManager ( ) : TUrlManager	Loads UrlManager instance from cache.
parseUrl ( ) : array	Parses the request URL and returns an array of input parameters (excluding GET variables).

Method Details