Class php_http_request

Description

An HTTP Request class

Located in /includes/domit/php_http_client_generic.php (line 42)


	
			
Direct descendents
Class Description
php_http_client_generic An HTTP Request class
Variable Summary
object A $headers
string $protocol
string $requestPath
Method Summary
object The &getHeaders ()
void setAuthorization (string $user, string $password)
void setHeader (string $name, string $value, [boolean $allowMultipleHeaders = false])
void setHeaders ()
boolean setProtocolVersion (string $version)
boolean setRequestMethod (string $method)
void setRequestPath (string $path)
Variables
object A $headers = null (line 44)
  • var: reference to the headers object
string $protocol = 'HTTP' (line 50)
  • var: The requested protocol
string $protocolVersion = '1.1' (line 52)
  • var: The version of the requested protocol
string $requestMethod = 'POST' (line 46)
  • var: The requested method, e.g. GET, POST, HEAD
string $requestPath = '' (line 48)
  • var: The requested path
Methods
getHeaders (line 58)

Returns the headers object

  • return: headers object
object The &getHeaders ()
setAuthorization (line 129)

Specifies a user name and password for basic authentication

void setAuthorization (string $user, string $password)
  • string $user: The user name
  • string $password: The password
setHeader (line 68)

Sets the header to the specified value

void setHeader (string $name, string $value, [boolean $allowMultipleHeaders = false])
  • string $name: The header name
  • string $value: The header value
  • boolean $allowMultipleHeaders: True if multiple headers with the same name are allowed
setHeaders (line 75)

Default method for setting headers; meant to be overridden in subclasses

void setHeaders ()

Redefined in descendants as:
setProtocolVersion (line 115)

Sets the version number of the protocol

  • return: True if the version number is valid
boolean setProtocolVersion (string $version)
  • string $version: The version number
setRequestMethod (line 86)

Sets the request method, e.g., GET

  • return: True if the version number is valid
boolean setRequestMethod (string $method)
  • string $method: The name of the request method
setRequestPath (line 106)

Sets the request path, e.g., http://www.engageinteractive.com/domit/test.xml

void setRequestPath (string $path)
  • string $path: The request path

Documentation generated on Fri, 4 Mar 2005 13:57:06 +1000 by phpDocumentor 1.3.0RC3