Class HttpRequestBuilder

Description

class HttpRequestBuilder

This class constructs the parts of the Request by implementing the RequestBuilder interface, defines and keeps track of the representation it creates and provides an interface for retrieving the Request object.

Located in /httprequestbuilder.class.php (line 20)

RequestBuilder
   |
   --HttpRequestBuilder
Variable Summary
Method Summary
Variables
mixed $HttpRequestBuilder (line 22)
  • static:
  • access: private
mixed $ipAddress (line 25)
  • access: private
mixed $ipAddresses (line 26)
  • access: private
mixed $proxyAddress (line 27)
  • access: private
mixed $Request (line 23)
  • access: private
Methods
Constructor __construct (line 36)

function __construct

This method is executed when an object is instantiated from this class. Preprocessing can be done here before the object is put into service.

  • access: public
HttpRequestBuilder __construct ()
BuildHttpAccept (line 98)

function BuildHttpAccept

This method sets the contents of the Accept: header from the current request, if there is one.

  • access: public
void BuildHttpAccept ()

Redefinition of:
RequestBuilder::BuildHttpAccept()
BuildHttpAcceptCharset (line 111)

function BuildHttpAcceptCharset

This method sets the contents of the Accept-Charset: header from the current request, if there is one.

  • access: public
void BuildHttpAcceptCharset ()

Redefinition of:
RequestBuilder::BuildHttpAcceptCharset()
BuildHttpAcceptEncoding (line 124)

function BuildHttpAcceptEncoding

This method sets the contents of the Accept-Encoding: header from the current request, if there is one.

  • access: public
void BuildHttpAcceptEncoding ()

Redefinition of:
RequestBuilder::BuildHttpAcceptEncoding()
BuildHttpAcceptLanguage (line 137)

function BuildHttpAcceptLanguage

This method sets the contents of the Accept-Language: header from the current request, if there is one.

  • access: public
void BuildHttpAcceptLanguage ()

Redefinition of:
RequestBuilder::BuildHttpAcceptLanguage()
BuildHttpConnection (line 150)

function BuildHttpConnection

This method sets the contents of the Connection: header from the current request, if there is one.

  • access: public
void BuildHttpConnection ()

Redefinition of:
RequestBuilder::BuildHttpConnection()
BuildHttpGet (line 162)

function BuildHttpGet

This method sets variables provided to the script via HTTP GET.

  • access: public
void BuildHttpGet ()

Redefinition of:
RequestBuilder::BuildHttpGet()
BuildHttpHost (line 175)

function BuildHttpHost

This method sets the contents of the Host: header from the current request, if there is one.

  • access: public
void BuildHttpHost ()

Redefinition of:
RequestBuilder::BuildHttpHost()
BuildHttpPost (line 187)

function BuildHttpPost

This method sets variables provided to the script via HTTP POST.

  • access: public
void BuildHttpPost ()

Redefinition of:
RequestBuilder::BuildHttpPost()
BuildHttpReferer (line 202)

function BuildHttpReferer

This method sets the address of the page (if any) which referred the user agent to the current page. This is set by the user agent. Not all user agents will set this, and some provide the ability to modify HTTP_REFERER as a feature. In short, it cannot really be trusted.

  • access: public
void BuildHttpReferer ()

Redefinition of:
RequestBuilder::BuildHttpReferer()
BuildHttpUserAgent (line 216)

function BuildHttpUserAgent

This method sets the contents of the User-Agent: header from the current request, if there is one. This is a string denoting the user agent being which is accessing the page.

  • access: public
void BuildHttpUserAgent ()

Redefinition of:
RequestBuilder::BuildHttpUserAgent()
BuildQueryString (line 229)

function BuildQueryString

This method sets the query string, if any, via which the page was accessed.

  • access: public
void BuildQueryString ()

Redefinition of:
RequestBuilder::BuildQueryString()
BuildRemoteAddress (line 242)

function BuildRemoteAddress

This method sets the IP address from which the user is viewing the current page.

  • access: public
void BuildRemoteAddress ()

Redefinition of:
RequestBuilder::BuildRemoteAddress()
BuildRemoteHost (line 256)

function BuildRemoteHost

This method sets the Host name from which the user is viewing the current page. The reverse dns lookup is based off the REMOTE_ADDR of the user.

  • access: public
void BuildRemoteHost ()

Redefinition of:
RequestBuilder::BuildRemoteHost()
BuildRemotePort (line 269)

function BuildRemotePort

This method sets the port being used on the user's machine to communicate with the web server.

  • access: public
void BuildRemotePort ()

Redefinition of:
RequestBuilder::BuildRemotePort()
BuildRemoteProxyAddr (line 282)

function BuildRemoteProxyAddr

This method sets the proxy IP address from which the user is being forwarded.

  • access: public
void BuildRemoteProxyAddr ()

Redefinition of:
RequestBuilder::BuildRemoteProxyAddr()
BuildRemoteProxyHost (line 295)

function BuildRemoteProxyHost

This method sets the Host name from which the user is being forwarded The reverse dns lookup is based off the REMOTE_PROXY_ADDR of the user.

  • access: public
void BuildRemoteProxyHost ()

Redefinition of:
RequestBuilder::BuildRemoteProxyHost()
BuildRequestMethod (line 307)

function BuildRequestMethod

This method sets the request method that was used to access the page.

  • access: public
void BuildRequestMethod ()

Redefinition of:
RequestBuilder::BuildRequestMethod()
BuildRequestUri (line 320)

function BuildRequestUri

This method retreives the URI which was given in order to access this page.

  • access: public
void BuildRequestUri ()

Redefinition of:
RequestBuilder::BuildRequestUri()
BuildServerProtocol (line 335)

function BuildServerProtocol

This method sets the name and revision of the information protocol via which the page was requested.

  • access: public
void BuildServerProtocol ()

Redefinition of:
RequestBuilder::BuildServerProtocol()
GetHttpClientIPAddress (line 65)

function GetHttpClientIPAddress

This method sets the end user's IP address and proxy address if there is one.

  • access: private
void GetHttpClientIPAddress ()
GetInstance (line 50)

function GetInstance

This method instantiates a new object from this class; more specifically, it's a singleton instance.

  • return: object instance
  • access: public
  • static:
HttpRequestBuilder GetInstance ()
GetRequest (line 348)

function GetRequest

This method returns the Request object to the calling method.

  • return: object instance
  • access: public
Request GetRequest ()

Redefinition of:
RequestBuilder::GetRequest()

Inherited Methods

Inherited From RequestBuilder

RequestBuilder::BuildHttpAccept()
RequestBuilder::BuildHttpAcceptCharset()
RequestBuilder::BuildHttpAcceptEncoding()
RequestBuilder::BuildHttpAcceptLanguage()
RequestBuilder::BuildHttpConnection()
RequestBuilder::BuildHttpGet()
RequestBuilder::BuildHttpHost()
RequestBuilder::BuildHttpPost()
RequestBuilder::BuildHttpReferer()
RequestBuilder::BuildHttpUserAgent()
RequestBuilder::BuildQueryString()
RequestBuilder::BuildRemoteAddress()
RequestBuilder::BuildRemoteHost()
RequestBuilder::BuildRemotePort()
RequestBuilder::BuildRemoteProxyAddr()
RequestBuilder::BuildRemoteProxyHost()
RequestBuilder::BuildRequestMethod()
RequestBuilder::BuildRequestUri()
RequestBuilder::BuildServerProtocol()
RequestBuilder::GetRequest()

Documentation generated on Thu, 9 Sep 2004 09:03:36 -0400 by phpDocumentor 1.3.0RC3